HTTP response codes are used to indicate the success or failure of an API request. In general:
- Codes in the
2xxrange indicate success. - Codes in the
4xxrange indicate an error that failed given the information provided. - Codes in the
5xxrange indicate an error with HFD's servers (these are rare).
| HTTP Code | Description |
|---|---|
| 200, 201 - OK | Everything worked as expected. |
| 400 - Bad Request | The request could not be completed, often due to a validation error. |
| 401 - Unauthorized | No valid API key provided. |
| 403 - Forbidden | The API key doesn't have sufficient permissions to perform the request. |
| 404 - Not Found | The requested resource doesn't exist. |
| 415 - Unsupported Media Type | The request was not in JSON format. |
| 429 - Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
| 500, 502, 503, 504 - Server Error | An error occurred on HFD's servers. |