API Error Codes
Our APIs can return multiple errors codes. Below the list of possible error codes and possible reasons of the error.
Bad Request (400)
Error Code | Description |
---|---|
badRequest | The API request is invalid or improperly formed. Consequently, the API server could not understand the request. |
badContent | The content type of the request data or the content type of a part of a multipart request is not supported. |
invalid | The request failed because it contained an invalid value. The value could be a parameter value, a header value, or a property value. |
invalidHeader | The request failed because it contained an invalid header. |
invalidParameter | The request failed because it contained an invalid parameter or parameter value. Review the API documentation to determine which parameters are valid for your request. |
invalidQuery | The request is invalid. Check the API documentation to determine what parameters are supported for the request and to see if the request contains an invalid combination of parameters or an invalid parameter value. Check the value of the q request parameter. |
invalidApiKey | The API key provided in the request is invalid, which means the API server is unable to check the quota limit for the application making the request. Use the developer portal to find your API key or to obtain one. |
parseError | The API server cannot parse the request body. |
required | The API request is missing required information. The required information could be a parameter or resource property. |
Unauthorized (401)
Error Code | Description |
---|---|
unauthorized | The user is not authorized to make the request. |
invalid | The authorization credentials provided for the request are invalid. Check the value of the Authorization HTTP request header. |
expired | Session Expired. Check the value of the Authorization HTTP request header. |
required | The user must be logged in to make this API request. Check the value of the Authorization HTTP request header. |
Forbidden (403)
Error Code | Description |
---|---|
forbidden | The requested operation is forbidden and cannot be completed. |
concurrentLimitExceeded | The request failed because a concurrent usage limit has been reached. |
quotaLimitExceeded | A quota limit for the API has been reached. |
limitExceeded | The request cannot be completed due to access or rate limitations. |
quotaExceeded | The requested operation requires more resources than the quota allows. |
rateLimitExceeded | Too many requests have been sent within a given time span. |
responseTooLarge | The requested resource is too large to return. |
userRateLimitExceeded | The request failed because a per-user rate limit has been reached. |
Not Found (404)
Error Code | Description |
---|---|
notFound | The requested operation failed because a resource associated with the request could not be found. |
unsupportedProtocol | The protocol used in the request is not supported. |
Method Not Allowed (405)
Error Code | Description |
---|---|
httpMethodNotAllowed | The HTTP method associated with the request is not supported. |
Conflict (409)
Error Code | Description |
---|---|
conflict | The API request cannot be completed because the requested operation would conflict with an existing item. For example, a request that tries to create a duplicate item would create a conflict, though duplicate items are typically identified with more specific errors. |
Too Many Requests (429)
Error Code | Description |
---|---|
rateLimitExceeded | Too many requests have been sent within a given time span. |
Internal Server Error (500)
Error Code | Description |
---|---|
internalError | The request failed due to an internal error. |
Not Implemented (501)
Error Code | Description |
---|---|
notImplemented | The requested operation has not been implemented. |
unsupportedMethod | The request failed because it is trying to execute an unknown method or operation. |
Service Unavailable (503)
Error Code | Description |
---|---|
backendError | A backend error occurred. |
backendNotConnected | The request failed due to a connection error. |
notReady | The API server is not ready to accept requests. |