Brale uses standard HTTP status codes to indicate whether an API request succeeded or failed. A response with a 2xx status code indicates success, a 4xx status code indicates a failure due to information provided with the request, and a 5xx status code indicates an unexpected error occurred. Errors are formatted according to the JSON:API spec.
| Error | Name | Description |
|---|---|---|
| 400 | Bad Request | An error occurred processing your request. |
| 401 | Unauthorized | A missing or invalid key was provided. |
| 403 | Forbidden | The provided token does not have the required permissions. |
| 404 | Not Found | Request entity not found. |
| 415 | Unsupported Media Type | Content-Type header should be application/vnd.api+json. |
| 422 | Unprocessable Entity | Unable to process the contained request instructions. |
| 429 | Rate Limited | Request has been rate-limited. |
| 500 | Internal Server Error | Something went wrong on Brale's side. |
{
"links": null,
"meta": null,
"errors": [
{
"code": "Forbidden",
"id": null,
"links": {},
"meta": {},
"status": "403",
"title": "Access not permitted.",
"source": null,
"detail": "Invalid scopes for requested endpoint."
}
]
}