Skip to navigation
Introduction

Error Codes

The Chariot API uses standard HTTP status response codes

CodeDescription
400Bad Request: The request could not be understood by the server due to malformed syntax.
401Unauthorized: The request requires user authentication. The Authorization header may be missing or invalid.
403Forbidden: The server understood the request but is refusing to fulfill it. The API user does not have correct permissions or the x-chariot-api-key header may be missing or invalid.
404Not Found: The resource requested does not exist or was not found.
405Method Not Allowed: The method/verb specified in the request is not allowed for the resource.
409Conflict: The request conflicts with the current state of the target resource.
410Gone: Access to the target resource is no longer available as the resource may have expired.
412Precondition Failed: The server does not meet one of the preconditions that the requester put on the request.
422Unprocessable Content: The server cannot process the request due to validation issues
500Internal Server Error: The request was valid, but something failed on the server.
502Bad Gateway: The server received an invalid response from an upstream server.
503Service Unavailable: The server is not ready to handle the request.

All error responses use the RFC 7807 problem-details format, returned with the application/problem+json media type. Every error response includes an X-Request-Id header you can quote when contacting support.

Problem Details
{
  "type": "about:blank",
  "title": "API Error",
  "status": 400,
  "detail": "The request is invalid or contains invalid parameters."
}

The fields are:

  • type — a URI reference identifying the problem type (currently always about:blank).
  • title — a short, constant summary (API Error).
  • status — the integer HTTP status code.
  • detail — a human-readable explanation specific to this error.