Errors

Dock API returns machine readable error codes, human readable error messages and a link to the docs for more information.

Here is how an error response looks like:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found."
  }
}

​

Error Codes

Here is a list of all error codes Dock API returns:

​

BAD_REQUEST

• Status: 400
• Problem: The request is malformed, either missing required fields, using wrong datatypes, or being syntactically incorrect.
• Solution: Check the request and make sure it is properly formatted.

​

UNAUTHORIZED

• Status: 401
• Problem: The client is unauthenticated, meaning it has not provided valid credentials to access the resource.
• Solution: Provide valid authentication credentials.

​

FORBIDDEN

• Status: 403
• Problem: The client is authenticated but does not have permission to access the requested resource.
• Solution: Verify that the client has the necessary access rights to the resource.

​

NOT_FOUND

• Status: 404
• Problem: The requested resource could not be found on the server.
• Solution: Ensure the requested URL or resource identifier is correct.

​

RATE_LIMIT_EXCEEDED

• Status: 429
• Problem: The client has sent too many requests in a short period, triggering rate limiting.
• Solution: Wait for a while before sending more requests, or adjust the request rate.

​

INTERNAL_SERVER_ERROR

• Status: 500
• Problem: The server encountered an unexpected condition that prevented it from fulfilling the request.
• Solution: This is a server-side issue. Try again later or contact support if the problem persists.