API errors

A failed request returns "ok": false with an error object containing a code, a message, and sometimes details:

{
  "ok": false,
  "error": {
    "code": "unauthorized",
    "message": "Use a valid Web API Bearer token."
  }
}

Authentication and access

HTTP status	Code	Message
401	`unauthorized`	Use a valid Web API Bearer token.
403	`organization_missing`	No active organization is linked to this account.
403	`forbidden`	Varies — for example, an action not available for your account, or a subdomain that is blocked from a particular action.

HTTP status	Code	Message
404	`not_found`	Endpoint not found. / Subdomain not found. / Support ticket not found.

HTTP status	Code	Example message
400	`invalid_json`	Request body must be valid JSON.
400	`validation_error` (and similar)	A valid platform domain is required. / A valid DNS label is required. / FQDN must be under a platform domain. / registration_mode must be free, plus, premium or special. / Subject and message are required. / Message is required.
405	`method_not_allowed`	Method not allowed. (the response includes an `Allow` header and an `allowed` list in `details`)

HTTP status	Code	Meaning
402	`insufficient_credits`	Your credit balance is too low to complete this request.
402	`payment_confirmation_required`, `pricing_changed`, `pricing_unavailable`	A quote is being shown; resend the request with `"confirm": true` to finalize, or the price could not be confirmed right now.
409	`request_failed`	The name is already taken, or reserved through an older/legacy record.
409	`renewal_unavailable`	Renewal is not available yet for this subdomain.
409	`ticket_closed`	This ticket is closed.

HTTP status	Code	Message
500	`server_error`	Unexpected server error.

No confirmed, currently active numeric rate limit is documented here — this page will be updated if one is introduced.