API status codes
Metronome uses conventional HTTP status codes to indicate the success or failure of an API request.
- Codes in the
2xxrange indicate success - Codes in the
4xxrange indicate an error caused by the client request - Codes in the
5xxrange indicate an error with Metronome's servers
Every 4XX error uses this application/json format:
{
"message": "Descriptive error text"
}
The table lists the most common HTTP status codes returned by the Metronome API, along with a possible solution.
| Code | Meaning | Description | Possible solution |
|---|---|---|---|
| 200 | OK | Everything worked as expected | N/A—the request was successful |
| 400 | Bad Request | The request was unacceptable, often due to malformed syntax, or a missing or malformed parameter | Ensure request syntax is correct |
| 401 | Invalid access token | Requestor is unauthorized or does not have permission for this API call | Ensure API token is valid |
| 403 | Forbidden | Requestor does not have access to this resource | Ensure API token is valid |
| 409 | Conflict | The request could not be processed due to a conflict with the current state of an existing resource | Ensure that the object does't already exist, and if using an Idempotency-Key header, check that it's unique |
| 429 | Too Many Requests | Too many requests hit the API too quickly | Wait and try again later |
| 5XX | Server Errors | Something went wrong while servicing your request | Retry your request |