Status codes
Metronome uses conventional HTTP status codes to indicate the success or failure of an API request.
- Codes in the 2xx range indicate success.
- Codes in the 4xx range indicate an error caused by the client request. Any 4XX error returned by Metronome will be
application/json
in the format below.
{
"message": "error text here"
}
- Codes in the 5xx range indicate an error with Metronome's servers - these are rare.
Table of status codes
Below is a table of the HTTP status codes that might be returned by Metronome's API
Code | Definition | 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 |
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 |