API error codes
Every error response has success: false and an error object with a machine-readable code, a human-readable
message, optional details and the request_id of the request (also sent as the X-Request-Id header: quote it when you contact support).
Switch on code, not on message. The HTTP status of a code never changes inside /v1, new codes can appear, so ignore codes you do not know.
{
"success": false,
"error": {
"code": "RECORD_NOT_FOUND",
"message": "Record not found or access denied",
"request_id": "3f6c1e0a-7d8b-4b7e-9c1a-2f3e4d5c6b7a"
}
}
An unknown path answers 404 NOT_FOUND. A 429 carries Retry-After (seconds) and the RateLimit and RateLimit-Policy headers.
Error codes
| Code | Status | Meaning |
|---|---|---|
ACCESS_DENIED | 403 | Admin access required |
ACCOUNT_FROZEN | 403 | Restricted Mode: the account is frozen, suspended or pending deletion |
ACCOUNT_NOT_ACTIVATED | 403 | Account not activated |
ACCOUNT_NOT_FOUND | 404 | Account not found |
ADD_DOMAIN_FAILED | 400 | The zone could not be added |
ALERT_RULE_LIMIT_REACHED | 403 | Alert rule limit of the plan reached |
AMOUNT_MISMATCH | 400 | Amount verification failed |
APEX_NOT_ALLOWED_ON_FREE_DOMAIN | 403 | Apex and wildcard records are not allowed on free shared domains |
API_ERROR | 400 | Generic API error (no more specific code) |
API_KEY_LIMIT | 400 | API key limit of the plan reached |
API_KEY_NOT_FOUND | 404 | API key not found |
API_KEY_REQUIRED | 403 | The operation needs an API key, not a session token |
ATTACH_VIEW_FAILED | 400 | The view could not be attached to the zone |
AUDIT_PERMISSION_DENIED | 403 | The team role may not read the audit log |
AUTH_FAILED | 401 | Authentication failed (wrong credentials, missing or invalid token) |
BATCH_FAILED | 422 | One or more operations of the batch failed, nothing was changed (details.errors lists them all) |
BILLING_PERMISSION_DENIED | 403 | Only the owner or a billing member may top up the wallet |
BILLING_PROFILE_REQUIRED | 400 | Billing details are incomplete for an invoice |
BULK_LIMIT_EXCEEDED | 400 | Too many records in one bulk request |
CERT_DATA_MISSING | 500 | Certificate data is not available |
CERT_NOT_ACTIVE | 409 | The certificate is not active |
CERT_REQUEST_FAILED | 422 | The certificate order was refused |
CHECKOUT_ERROR | 500 | Creating the checkout failed |
CNAME_AT_APEX_NOT_ALLOWED | 422 | A CNAME is not allowed at the zone apex (it would replace the SOA and NS records) |
CNAME_CONFLICT | 422 | A CNAME cannot coexist with other records at the same name |
CONTENT_TOO_LONG | 400 | The record content is longer than 65535 bytes |
CURRENCY_MISMATCH | 400 | The currency does not match the account billing currency |
DAILY_SPEND_LIMIT_EXCEEDED | 402 | The daily spend limit of the API key is exhausted |
DATABASE_ERROR | 500 | A database error occurred |
DNSSEC_ALREADY_ENABLED | 409 | DNSSEC is already enabled for this zone |
DNSSEC_INVALID_ALGORITHM | 400 | Unsupported DNSSEC algorithm |
DNSSEC_NOT_ENABLED | 409 | DNSSEC is not enabled for this zone |
DNS_LIMIT_EXCEEDED | 403 | Free account host limit reached |
DOMAIN_CHECK_FAILED | 500 | The availability check failed |
DOMAIN_EXISTS | 409 | Domain already exists in system |
DOMAIN_NOT_AVAILABLE | 409 | The domain is not available for registration |
DOMAIN_NOT_FOUND | 404 | Domain not found |
DOMAIN_STILL_ACTIVE | 403 | A registered domain that is still valid cannot be removed |
DOMAIN_UNAVAILABLE | 409 | The domain is not available |
DPAY_API_ERROR | 502 | Payment provider error |
DPAY_CONNECTION_ERROR | 502 | Payment provider unreachable |
DPAY_REGISTRATION_FAILED | 502 | Payment provider refused to register the payment |
EMAIL_REQUIRED | 400 | E-mail address is required |
EMPTY_CART | 400 | Cart is empty |
EMPTY_CONTENT | 400 | Record content is required |
EMPTY_RRSET | 422 | An RRset needs at least one record; use DELETE to remove it |
FORBIDDEN | 403 | Not allowed for this role or key |
HOMOGRAPH_NOT_ALLOWED_ON_FREE_DOMAIN | 422 | This host name mixes scripts or contains look-alike, invisible or symbol characters and is not allowed on free shared domains |
HOMOGRAPH_RISK | 422 | This name mixes scripts or contains look-alike, invisible or symbol characters and cannot be registered |
INSUFFICIENT_BALANCE | 402 | Wallet balance too low for the operation |
INSUFFICIENT_FUNDS | 400 | Wallet funds are not enough |
INSUFFICIENT_SCOPE | 403 | The API key lacks the required scope |
INTERNAL_ERROR | 500 | Unexpected server error |
INVALID_AMOUNT | 400 | The amount is outside the allowed range |
INVALID_BASE_NAME | 400 | Invalid base name |
INVALID_CAA | 400 | The content of the CAA record is not valid |
INVALID_CDNSKEY | 400 | The content of the CDNSKEY record is not valid |
INVALID_CDS | 400 | The content of the CDS record is not valid |
INVALID_CONTENT | 400 | Record content must be a string |
INVALID_CSR | 422 | The certificate signing request is not valid |
INVALID_CURRENCY | 400 | Unsupported currency |
INVALID_CURSOR | 422 | Invalid or expired cursor |
INVALID_DNAME | 400 | The content of the DNAME record is not valid |
INVALID_DOMAIN | 400 | Invalid domain format |
INVALID_DOMAIN_FORMAT | 400 | Invalid domain format |
INVALID_DS | 400 | The content of the DS record is not valid |
INVALID_EMAIL | 400 | A valid e-mail address is required |
INVALID_HOSTNAME | 400 | The host name is not valid |
INVALID_HTTPS | 400 | The content of the HTTPS record is not valid |
INVALID_IP | 400 | Not a valid IPv4 address |
INVALID_IPN | 400 | The payment notification is not valid |
INVALID_IPV6 | 400 | Not a valid IPv6 address |
INVALID_LIMIT | 422 | limit must be between 1 and the maximum page size |
INVALID_LOC | 400 | The content of the LOC record is not valid |
INVALID_MX | 400 | The MX host name is not valid |
INVALID_NAPTR | 400 | The content of the NAPTR record is not valid |
INVALID_NETWORK | 400 | The network must be CIDR, for example 203.0.113.5/32 |
INVALID_OPENPGPKEY | 400 | The content of the OPENPGPKEY record is not valid |
INVALID_PARAMS | 400, 422 | A query or body parameter is not valid |
INVALID_PASSWORD | 403 | Incorrect password |
INVALID_PHONE | 400 | The phone number is not valid |
INVALID_PRIO | 400 | The priority of a record must be an integer between 0 and 65535 |
INVALID_PTR_CONTENT | 400 | PTR content must be a fully qualified name |
INVALID_QUERY | 400 | The search query is too short |
INVALID_RECORD_TYPE | 400 | Unknown DNS record type |
INVALID_REQUEST | 400 | The request body must be a JSON object |
INVALID_SOA | 400 | The content of the SOA record is not valid |
INVALID_SOURCE | 400 | Unknown source |
INVALID_SRV | 400 | The content of the SRV record is not valid |
INVALID_SSHFP | 400 | The content of the SSHFP record is not valid |
INVALID_SVCB | 400 | The content of the SVCB record is not valid |
INVALID_SYNC_CHANGE | 400 | Each sync change requires a name, a type and a valid action (add, update or remove) |
INVALID_TLSA | 400 | The content of the TLSA record is not valid |
INVALID_TOTAL | 400 | Order total must be greater than 0 |
INVALID_TOTP_CODE | 403 | The two-factor code is wrong |
INVALID_TTL | 400 | TTL outside the range any plan allows (1 to 86400) |
INVALID_TXT | 400 | The content of the TXT record is not valid (a value is at most 4096 bytes) |
INVALID_TYPE | 400 | Unknown record type |
INVALID_URI | 400 | The content of the URI record is not valid |
INVALID_USER_ID | 400 | Invalid user ID |
INVALID_UUID | 400 | The transaction UUID is not valid |
INVALID_VIEW_LABEL | 400 | A view label is required |
INVALID_WEBHOOK | 400 | Invalid webhook data |
INVALID_ZONE | 400 | The zone cannot be used for this operation |
INVOICE_DOWNLOAD_FAILED | 502 | The invoice PDF could not be retrieved |
INVOICE_NOT_AVAILABLE | 404 | No invoice for this transaction |
IP_NOT_ALLOWED | 403 | The API key may not be used from this address |
JWT_REQUIRED | 403 | The operation needs a session token, not an API key |
MAGIC_LINK_INVALID | 401 | The sign-in link is invalid or expired |
MANDATE_ALREADY_ACTIVE | 409 | Auto-renewal is already enabled |
MANDATE_FAILED | 400 | The recurring mandate has failed, it cannot be charged |
MANDATE_NOT_FOUND | 404 | Recurring mandate not found |
METHOD_NOT_ALLOWED | 405 | The path exists but not for this method (see the Allow header) |
MISSING_DOMAIN | 400 | Domain name missing in order item |
MISSING_ZONE_DATA | 400 | zone_data is required |
MONITOR_LIMIT_REACHED | 403 | Monitor limit of the plan reached |
MOVE_VIEW_FAILED | 400 | The zone could not be moved to the view |
NAME_NOT_ALLOWED | 403 | The name is outside the zones allowed for the API key |
NETWORK_ALREADY_IN_VIEW | 409 | The network is already in this view |
NETWORK_ALREADY_TAKEN | 409 | This network overlaps a range already claimed by another account |
NETWORK_NOT_FOUND | 404 | Network not found for this view |
NETWORK_NOT_PUBLIC | 400 | The network is not public address space |
NOT_EU_COUNTRY | 400 | VIES validation is available for EU countries only |
NOT_FOUND | 404 | Resource not found (also an unknown path) |
NOT_MANAGED | 400 | AuthInfo is only available for domains registered through no-ip.pl |
NO_PAID_PLAN | 400 | No paid plan on the account |
NO_PROVIDER_AVAILABLE | 400 | No payment provider for the currency |
NO_TLDS_SPECIFIED | 400 | At least one TLD must be specified |
NULL_MX_CONFLICT | 422 | A null MX (RFC 7505) must be the only MX record of its name |
ORDER_NOT_FOUND | 404 | Order not found |
PARENT_ZONE_DELEGATED_TO_OTHER_ACCOUNT | 409 | The parent zone delegates this name to another account |
PARENT_ZONE_OWNED_BY_OTHER_ACCOUNT | 409 | The parent zone belongs to another account and does not delegate to our name servers |
PASSKEY_ERROR | 400 | The passkey assertion is not valid |
PASSWORD_REQUIRED | 400 | Password is required to delete account |
PAYMENT_CREATION_FAILED | 502 | The payment could not be created |
PDNS_ERROR | 400, 503 | DNS backend error |
PDNS_NOT_CONFIGURED | 500 | DNS backend not configured |
PDNS_UNREACHABLE | 503 | DNS backend unreachable |
PERSONAL_DATA_REQUIRED | 400 | Personal data is required to register a domain |
PLAN_NOT_FOUND | 404 | Plan not found |
PLAN_UPGRADE_REQUIRED | 403 | The feature needs a higher plan |
PRICING_ERROR | 500 | No price configured for the product |
PROFILE_EXISTS | 409 | A profile with this label already exists |
PROFILE_INCOMPLETE | 400 | The account profile is incomplete for a registration |
PROFILE_LIMIT_EXCEEDED | 403 | Profile limit of the plan reached |
PROFILE_NOT_FOUND | 404 | Profile not found |
PROVIDER_NOT_FOUND | 400 | Payment provider not found |
PROVIDER_UNSUPPORTED | 400 | The payment provider does not support the currency |
PTR_ZONE_MISMATCH | 400 | The PTR name does not fit the reverse zone |
RATE_LIMIT_EXCEEDED | 429 | Too many requests; see Retry-After |
RECORD_EXISTS | 409 | DNS record already exists |
RECORD_LIMIT_REACHED | 403 | Record limit of the plan reached |
RECORD_NOT_FOUND | 404 | Record not found or access denied |
RECURRING_CHARGE_ERROR | 500 | Charging the recurring mandate failed |
RECURRING_INIT_ERROR | 500 | Starting the recurring mandate failed |
RECURRING_INIT_FAILED | 502 | The payment provider refused the recurring mandate |
REGISTRAR_ERROR | 502 | The registrar did not do what was asked |
REGISTRATION_FAILED | 400 | The registrar refused the registration |
RENEWAL_FAILED | 400 | The registrar refused the renewal |
RRSET_NOT_EDITABLE | 422 | This RRset is managed by the platform (SOA) |
RRSET_NOT_FOUND | 404 | RRset not found |
RRSET_SINGLE_VALUE | 422 | A CNAME, ALIAS or DNAME RRset has exactly one record |
RRSET_TOO_LARGE | 422 | The TXT values of one name together exceed 16384 bytes |
SIBS_API_ERROR | 502 | Payment provider error |
SIBS_CHECKOUT_FAILED | 502 | The payment provider could not create the checkout |
SIBS_CONNECTION_ERROR | 502 | Payment provider unreachable |
SYNC_EMPTY | 502 | The registrar returned no TLDs |
SYNC_FAILED | 500 | Synchronising prices failed |
TEAM_MEMBER_EXISTS | 409 | This member already has that role/zone combination |
TEAM_MEMBER_LIMIT_REACHED | 403 | Team member limit of the plan reached |
TEMPLATE_CONFLICT | 409 | The zone holds records that contradict the template |
TEMPLATE_EXISTS | 409 | A template with this name already exists |
TEMPLATE_LIMIT_EXCEEDED | 403 | Template limit of the plan reached |
TEMPLATE_NOT_FOUND | 404 | Template not found |
TEST_TOO_SOON | 429 | A test was sent a moment ago; see Retry-After |
TLD_NOT_AVAILABLE | 400 | Registration for this TLD is not available |
TOKEN_REQUIRED | 400 | A token is required |
TOTP_ALREADY_ENABLED | 409 | Two-factor authentication is already enabled |
TOTP_ERROR | 422 | Two-factor setup failed |
TOTP_INVALID | 422 | The two-factor code is wrong |
TOTP_NOT_ENABLED | 422 | Two-factor authentication is not enabled |
TOTP_REQUIRED | 403 | The change widens an API key and needs a two-factor code |
TRANSACTION_NOT_FOUND | 404 | Transaction not found |
TRANSFER_FAILED | 400 | The registrar refused the transfer |
TRANSFER_LOCK_NOT_SUPPORTED | 409 | The registrar has no transfer lock for this TLD |
TTL_BELOW_PLAN_MINIMUM | 422 | TTL is below the minimum of the plan (details.min_ttl, details.plan) |
TTL_MISMATCH | 422 | Records of one name and type must share one TTL |
UNKNOWN_ITEM_TYPE | 400 | Unknown order item type |
USER_NOT_FOUND | 404 | User not found |
VALIDATION_ERROR | 422, 400 | A field is missing or not valid; see error.details |
VIEW_EXISTS | 409 | You already have a view with this label |
VIEW_HAS_ZONES | 409 | The view still serves zones (use force) |
VIEW_NOT_FOUND | 404 | View not found |
VIEW_UNCHANGED | 409 | This zone already uses this view |
WEBHOOK_LIMIT_REACHED | 403 | Webhook limit of the plan reached |
WFIRMA_API_ERROR | 502 | Invoicing service error |
WFIRMA_CONNECTION_ERROR | 502 | Invoice PDF could not be fetched |
WFIRMA_UNEXPECTED_RESPONSE | 502 | Unexpected answer from the invoicing service |
ZONE_HAS_VIEWS | 409 | The zone is attached to views (use force) |
ZONE_LIMIT_REACHED | 403 | Zone limit of the plan reached |
ZONE_LOCKED | 403 | This zone is locked on your current plan |
ZONE_NOT_FOUND | 404 | Zone not found or access denied |
ZONE_TOO_BROAD | 400 | The reverse zone is too broad for the plan |
ZONE_UNDER_PLATFORM_ZONE | 409 | Sub-zones of a platform zone cannot be created |
Related
- Restricted Mode:
ACCOUNT_FROZEN. - API changelog.