Standardized Problem Types

A list of problem types is standardized in this guide for reuse across all REST APIs. They are defined as URNs of format urn:problem-type:<type>.

href links to descriptions of standardized problem types will change in the future to recommended format containing full problem type identifier without HTML extension. Current URLs will redirect.


Bad Request

The input message is incorrect. Look for more details in the issues property.

No Access Token

The consumer must pass a valid access token in the Authorization HTTP header for each request to a secure resource.

Invalid Access Token

The consumer must pass a valid access token in the Authorization HTTP header for each request to a secure resource.

Expired Access Token

The access token passed in the Authorization HTTP header has expired and cannot be used anymore. Renew the access token and resubmit the request.

Missing Scope

The consumer access token doesn’t have the required scope to invoke the operation. The requiredScopes property lists the required scopes.

Missing Permission

The consumer doesn’t have the right to invoke an operation on the given resource.

Resource Not Found

The requested resource cannot be found. The detail property reveals additional information about why the resource was not found.

Payload Too Large

The consumer request was refused because its payload is too large.

Too Many Requests

The consumer quota was exceeded.

Too Many Failed Requests

No more new requests are accepted because the consumer quota for failed requests was exceeded.

Internal Server Error

The server has encountered a situation it doesn’t know how to handle.

Bad Gateway

The API, acting as a gateway or proxy to an API provided by a third party, received an invalid response from the upstream server.

Service Unavailable

The service is unavailable, because of a planned or unplanned downtime.