API Errors
Table of Contents
- What does each status code mean?
- Which error messages are most common?
- Where can I find the full error reference?
- Have more questions?
When a DNSimple API request fails, the response has a 4xx or 5xx HTTP status code and a JSON body with at least a message key. Validation errors can also include an errors key with details for each field. The status code tells you what kind of problem it is, and the message tells you the specific cause.
What does each status code mean?
| Status | Meaning |
|---|---|
400 Bad Request |
The request or its payload is invalid. |
401 Unauthorized |
The authentication credentials are invalid. |
402 Payment Required |
The account is not subscribed or not in good standing. |
403 Permission Denied |
The access token does not have permission for this resource. |
404 Not Found |
The resource does not exist, or the account does not have access to it. |
412 Precondition Failed |
The account’s plan does not include a feature the request needs. |
429 Too Many Requests |
The request went over a rate limit. |
500, 502, 503, 504
|
Something went wrong on DNSimple’s side. |
Which error messages are most common?
| Status | Message | Cause |
|---|---|---|
| 401 | Authentication failed |
The token is invalid, deleted, or disabled. A Sandbox token sent to the production API also returns this. |
| 403 | Permission Denied. Required Scope: ... |
A scoped access token does not have the permission the request needs, or is limited to other domains or zones. The message names the scope that is missing. |
| 412 | Feature not enabled: ... |
The account’s plan does not include the feature. For example, a scoped access token stops working with Feature not enabled: scoped_access_tokens if the account moves to a plan without scoped tokens. |
| 429 | quota exceeded |
The account went over its hourly limit. See API Rate Limit for the other 429 messages. |
Where can I find the full error reference?
See Errors in the developer documentation.
Have more questions?
If you have additional questions or need any assistance with API errors, contact support, and we will be happy to help. You can also read more about the DNSimple API.