Status and Error Codes

The API generates the following HTTP status responses.

Status

Explanation

200: OK

Standard response for successful HTTP requests. The actual response depends on the request method used.

In a GET request, the response contains an entity corresponding to the requested resource.

In a POST request, the response contains an entity describing or containing the result of the action.

201: Created

The request has been fulfilled and a new resource has been created. The location of the resource is included in the response headers.

204: No Content

The request has been processed, but no content is returned. The response is typical with PUT and DELETE requests.

400: Bad Request

The server cannot or will not process the request because something is perceived to be a client error, such as malformed request syntax, invalid request message framing, or deceptive request routing.

403: Forbidden

The server cannot process this resource because the current user does not have access to this resource based on the configured scope or missing privilege. For example, the user is not scoped to the corresponding entity that is being requested.

404: Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are allowed.

409: Conflict

The request caused a conflict in the system. Response contains more specific message.

500: Internal server error

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

Data Source Configuration API overview

Use cases