API Responses - Status Codes

The platform API returns a number of different HTTP status codes in the response depending on the incoming request and the state of the system.

Successful Requests

For requests, that are successful, 2xx status codes are returned.

Status Code	Description
200 OK	The request was successfully processed
201 Created	The request was successfully processed and one or more resources was created
202 Accepted	The request was successfully accepted for processing. This is usually used when the request is processed asynchronously.

Failed Requests

For requests, that are not successful, 4xx status codes are returned if the incoming request has errors or 5xx errors if caused due to issues in the platform.

Status Code	Description
400 Bad Request	The incoming request is not well-formed, does not conform to the schema or violates data validation rules.
403 Forbidden	The incoming request is valid but does not have the authorization to access the target resource.
404 Not Found	Indicates that the requested resource does not exist. This could be caused because the resource is not available or due to insufficient access privileges for the requested resource.
500 Internal Server Error	An internal error occurred in the platform indicating that something unexpected happened in the platform
503 Service Unavailable	An internal error that indicates the the platform is unable to handle the request and likely will be alleviated after some time.