Errors
The Cumulus9 API follows standard HTTP response codes to indicate success or failure. If an error occurs, the response will include a JSON object with an error field that provides details about what went wrong.
Status codes
Here is a list of the different categories of status codes returned by the API. Use these to understand if a request was successful.
- Name
2xx- Description
A 2xx status code indicates a successful response.
- Name
4xx- Description
A 4xx status code indicates a client side error — this means it's a you problem.
- Name
5xx- Description
A 5xx status code indicates a server side error — these are rare.
Common Error Codes
- Name
400- Description
Occurs when the request is malformed or missing required parameters.
Possible Causes:
- Invalid client
- Invalid request body structure
Bad Request error response
{
"error": "invalid_client",
"error_description": "Client authentication failed due to unknown client, no client authentication included, or unsupported authentication method."
}
- Name
401- Description
Occurs when authentication fails due to missing or invalid credentials.
Possible Causes:
- Invalid authentication header format
- Expired access token
Unauthorized error response
{
"error": {
"message": "AWS Cognito: JWSInvalid rejection"
}
}