Skip to content

Commit

Permalink
EES-5397 Add detail about 504 status codes
Browse files Browse the repository at this point in the history
  • Loading branch information
@ntsim
ntsim committed Oct 8, 2024
1 parent f62b535 commit dec973f
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions source/overview/error-handling/index.html.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ within the API itself.

The HTTP status codes that you can typically expect from the API are summarised by the following table:

| Status code | Name | Description |
|-------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------|
| 200 | OK | Success. The API should provide a successful response. |
| 204 | No Content | Success. The request succeeded, but there was no content in the response. |
| 400 | Bad Request | There were issues (e.g. validation errors) with the request meaning it could not be processed. |
| 401 | Unauthorized | The request lacks valid authentication credentials and was denied access. |
| 403 | Forbidden | The request has authentication credentials, but was denied access to the requested resource. |
| 404 | Not Found | The requested resource could not be found. |
| 429 | Too Many Requests | There were too many requests in a short amount of time. Avoid making further requests, or use an appropriate backoff strategy. |
| 500 | Internal server error | Something went wrong whilst processing the request. This may require further assistance to resolve. |
| Status code | Name | Description |
|-------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------|
| 200 | OK | Success. The API should provide a successful response. |
| 204 | No Content | Success. The request succeeded, but there was no content in the response. |
| 400 | Bad Request | There were issues (e.g. validation errors) with the request meaning it could not be processed. |
| 401 | Unauthorized | The request lacks valid authentication credentials and was denied access. |
| 403 | Forbidden | The request has authentication credentials, but was denied access to the requested resource. |
| 404 | Not Found | The requested resource could not be found. |
| 429 | Too Many Requests | There were too many requests in a short amount of time. Avoid making further requests, or use an appropriate backoff strategy. |
| 504 | Gateway Timeout | The request was not successful as it took longer than the maximum allowed time. |

## The error response body

Expand Down

0 comments on commit dec973f

Please sign in to comment.