Tamr Cloud API calls return conventional HTTP success or error status codes.
On success, calls return a response code of 200 and the expected object.
For errors, the API provides information about what went wrong. All errors are returned as JSON objects.
Error Types
The following table describes the data and metadata for an error.
Key | Value Description |
---|---|
statusCode | The HTTP status code of the error returned. |
message | A short description of the error. |
HTTP Status Codes
Status Code | Text |
---|---|
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
409 | Conflict |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
Retrying Requests
Requests that fail with certain status codes often indicate temporary conditions that resolve within a short amount of time. Typically, these requests can be retried successfully after a brief wait.
Requests that return the following codes can be retried: 429, 500, 503.
As a best practice, retry requests after a 30 second wait. If the condition persists after a 30 second wait, retry the request repeatedly at intervals until the issue resolves.
429 errors may indicate rate limiting or quota exhaustion. In these cases, retry with exponential backoff to attenuate load and wait for capacity to free up. See Usage and Rate Limits for more details.