HTTP status codes

When an API is called, different HTTP status codes are returned to indicate whether the request was successful or failed.

Response codes correspond to the IANA registered HTTP status codes as listed in IANA registry.
  • 1xx - Informational
  • 2xx - Successful
  • 3xx - Redirection
  • 4xx - Client error
  • 5xx - Server error

Successful responses vary depending on the API being called. Depending on the assembly and the response from external systems, other response codes can be generated. The standard reasons listed for registered HTTP status codes are considered adequate for most responses. Therefore, these response codes and their causes are not listed here.

In certain cases, a client or server error status code can be caused by a specific configuration. The following table contains this list and identifies possible causes. For some error codes, multiple causes are possible.

Table 1. Error status codes and causes
Error code Cause
401 Unauthorized
  • The required client ID, secret, or client ID and secret were not provided.
  • User authentication failed or did not take place.
403 Forbidden
  • The collection is not registered with the plan that is used.
  • The collection is not active.
  • User authentication failed because multiple client IDs provided.
404 Not Found
  • Information for the provider organization or environment was not found.
  • The API URL was not found in the organization or environment.
405 Method Not Allowed The API URL was found, but no operation is found that supports the requested HTTP verb.
406 Not Acceptable The API cannot produce a response that the collection supports.
429 Too Many Requests Exceeded the rate limit for the plan or operation.
500 Internal Server Error An error occurred during request processing of the API or assembly.
503 Service Unavailable The API is unavailable.
Beyond reviewing the system logs, you can troubleshoot the situation by using one of the following methods.
  • Enable debug headers in OAuth provider settings, and process the request again. For details, see OAuth providers.
  • Enable the API probe, and process the request again. For details, see API probe.