Skip to content
Docs
Open Backstage
Reference

Error codes

Every error code the Backstage API sends, grouped by HTTP status, and the moreInfo address that points at it.

Every error response from the Backstage API carries a code, and every code has a page here at /error/{CODE}. The API puts that page's address on the response as error.moreInfo, with the request id in the query string, so the address in an error body is a link to what the code means and what to do about it:

{
  "status": "error",
  "error": {
    "code": "CHANNEL_REQUIRED",
    "message": "A channel is required",
    "moreInfo": "https://docs.ticketlayer.com/error/CHANNEL_REQUIRED?request=req_01j9x2k3m4n5p6q7r8s9t0v1w2"
  },
  "metadata": {
    "requestId": "req_01j9x2k3m4n5p6q7r8s9t0v1w2"
  }
}

The request query parameter is the same id as metadata.requestId. A code's page shows it when it is present, so an address pasted from a log or a support ticket keeps the request it came from; quote it when you contact support. The envelope itself is described in Response format and errors.

The list below is written from the API's own table of codes, grouped by the HTTP status each one is sent with.

400 Bad Request#

401 Unauthorized#

403 Forbidden#

404 Not Found#

409 Conflict#

410 Gone#

412 Precondition Failed#

413 Payload Too Large#

422 Unprocessable Entity#

429 Too Many Requests#

500 Internal Server Error#

501 Not Implemented#

502 Bad Gateway#

503 Service Unavailable#