Articles on: API

API responses

CloudOnex API calls return HTTP status codes. Some API calls also return JSON response bodies that include information about the resource.

HTTP status codes

Each REST API request returns a success or error HTTP status code.


In the responses, CloudOnex returns these HTTP status codes for successful requests:

200 OK The request succeeded.

201 Created A POST method successfully created a resource. If the resource was already created by a previous execution of the same method, for example, the server returns the HTTP 200 OK status code.

202 Accepted The server accepted the request and will execute it later.

204 No Content The server successfully executed the method but returns no response body.


In the responses for failed requests, CloudOnex returns HTTP 4XX or 5XX status codes.

CloudOnex returns an error response body that includes additional error details in this format:

    "name": "ERROR_NAME",
    "message": "ERROR_DESCRIPTION",
    "information_link": "ERROR_DOCUMENTATION_LINK",
    "details": "ERROR_DETAILS"

In the responses, CloudOnex also returns these HTTP status codes for failed requests:

400 Bad Request Request is not well-formed, syntactically incorrect, or violates schema.

401 Unauthorized Authentication failed due to invalid authentication credentials.

403 Forbidden Authorization failed due to insufficient permissions.

404 Not Found The specified resource does not exist.

405 Method Not Allowed The server does not implement the requested HTTP method.

406 Not Acceptable The server does not implement the media type that would be acceptable to the client.

422 Unprocessable Entity The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.

429 Unprocessable Entity Too many requests. Blocked due to rate limiting.

500 Internal Server Error An internal server error has occurred.

503 Service Unavailable Service Unavailable.

Updated on: 29/12/2017

Was this article helpful?

Share your feedback


Thank you!