HTTP Status Codes

API Version: v4

HTTP Status Codes

**Availability, Access, Security and AuthenticationFailure
Every API request will result in one of the following common HTTP status codes returned in the response header. The HTTP status codes relate to the API interface request.

Status CodeStatus TypeStatus NameStatus Description
200SuccessCompleted/OKThe synchronous request has been completed
202SuccessCreated/AcceptedThe asynchronous request has been created and will be returned over a callback HTTP POST
301FailureMoved PermanentlyThe requested resource is no longer accessible and has been assigned a new permanent URI. The user agent will not automatically redirect.
400FailureBad RequestThe request cannot be fulfilled due to bad syntax
401FailureUnauthorizedAuthentication is required and has failed or has not yet been provided. Typical Cause: Either the IP server address has not been white listed or the API credentials are not valid.
403FailureForbiddenThe request was a valid request, but the server is refusing to respond to it. Unlike a 401 Unauthorized response, authenticating will make no difference. Typical Cause: The required parameters were not provided in the request.
404FailureNot FoundThe requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
405FailureMethod Not AllowedA request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST.
408FailureRequest TimeoutThe server timed out waiting for the request. The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.
500FailureInternal Server ErrorA generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
503FailureService UnavailableThe resource is currently unavailable. Generally, this is a temporary state and subsequent requests by the client are permissible.

This page was last updated 1522879083945