Errors

Automox uses conventional HTTP response codes to indicate the success or failure of an API request.

Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (for example, an invalid parameter, resource does not exist). Codes in the 5xx range indicate an error with Automox’s services and are rare. List of commonly used status codes at Automox and their usage:

Code

Description

200 OK

The request succeeded.

201 Created

A new resource was created successfully.

204 No Content

There is no content to send for this request, but the headers may be useful. Frequently seen with DELETE requests.

304 Not Modified

This is used for caching purposes. It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response.

400 Bad Request

The request was unacceptable, often due to missing a required parameter.

401 Unauthorized

Used when the client must be authenticated to view the response.

402 Payment Required

An Organization’s subscription does not allow access to an endpoint or service.

403 Forbidden

Client is authenticated but is not authorized for the resource or action.

404 Not Found

The requested resource or endpoint is not found. Services may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.

405 Method Not Allowed

The resource exists but the method is not allowed for it. A common usage is to disable DELETE-ing. Should not be used with GET or HEAD requests.

429 Too Many Requests

Too many requests hit the API too quickly from this user-agent or IP.