API errors

Look up any error the Cloud API returns: what it means, what causes it and how to fix the call.

What every error response carries

Every error is a JSON document in RFC 9457 format, with these members:

MemberWhat it holds
typeThe error's name, such as not-found. Its page is /docs/errors/<type>.
titleA short English title for the type.
statusThe HTTP status.
detailWhat went wrong with this call, for a person to read.
requestId, timestampWhich call this was, and when.
path, method, instanceThe call that failed. instance is the method and path together.
docsThe link to the type's page.
errorsOn a validation error, and on any other 4xx that can name the field at fault, one entry per field.

The CLI puts this document under error in its JSON output.

Request and validation

Authentication and permissions

A call signs in with an access token traded for an API key.

Missing resources

Duplicates and conflicts

Resource state and connections

Idempotency

Server-side and upstream