Errors

Saqara uses standard HTTP response codes to indicate the success or failure of an API request:

2xx codes indicate success 4xx codes indicate an error that failed given the information provided 5xx codes indicate an error with our servers An error and a troubleshoot key will be present in the response payload body. The troubleshoot key is a readable description of the error.

More detailed HTTP response codes will be provided in endpoints documentation

Code descriptions

Code Description
200 OK - The request has succeeded.
201 Created - The request has been fulfilled and has resulted in one or more new resources being created.
204 No Content - Server has successfully fulfilled the request, no additional content sent in the response payload body.
400 Bad Request - Server cannot process the request due to something that is perceived to be a client error.
401 Unauthorized - Lack of valid authentication credentials for the target resource.
404 Not Found - Server did not find the target resource.
405 Method Not Allowed - The method is known by the server but not supported.
422 Unprocessable Entity - The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions..It happens when the data sent in the POST/PUT or DELETE request is invalid.
500 Internal Server Error - Server encountered an unexpected condition.

Error example response

{
    "code": 404, // The HTTP code
    "message": "..." // A description
}