Response Format - PanelDNS

Envelope

All responses — success and error — are wrapped in a consistent JSON envelope.

{
  "ok": true,
  "data": { ... }
}

List endpoints include a meta object for pagination:

{
  "ok": true,
  "data": [ ... ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 237
  }
}

{
  "ok": false,
  "error": "Zone not found.",
  "code": 404
}

The HTTP status code matches code.

Code	Meaning
`200`	OK
`201`	Created
`204`	No content (used on some deletes)
`400`	Bad request / validation failure
`401`	Missing or invalid authentication
`403`	Forbidden (wrong scope, protected resource, suspended org)
`404`	Resource not found
`409`	Conflict (duplicate, already exists)
`422`	Unprocessable entity (business-logic error)
`429`	Rate limited
`502`	Provider error (DNS provider returned an error)

Paginated endpoints accept ?page=N&per_page=N. The default and maximum per_page varies by endpoint and is noted in each endpoint’s docs.

All timestamps are ISO 8601 with UTC timezone, e.g. 2026-06-04T17:00:00.000000Z.