API errors
Look up any error the Cloud API returns: what it means, what causes it and how to fix the call.
All pages
Every error is a JSON document in RFC 9457 format, with these members:
| Member | What it holds |
|---|---|
type | The error's name, such as not-found. Its page is /docs/errors/<type>. |
title | A short English title for the type. |
status | The HTTP status. |
detail | What went wrong with this call, for a person to read. |
requestId, timestamp | Which call this was, and when. |
path, method, instance | The call that failed. instance is the method and path together. |
docs | The link to the type's page. |
errors | On 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.
- validation-error
- bad-request
- unprocessable-entity
- too-many-requests
- dry-run-unsupported
- backups-unsupported
- bucket-object-too-large
- bucket-upload-invalid
- bucket-across-sites
- not-a-database
- metrics-window-out-of-range
- deploy-rate-limit-exceeded
- reserved-slug
- host-not-gated
- plan-not-self-selectable
- month-out-of-range
- workspace-header-required
- test-email-throttled
A call signs in with an access token traded for an API key.
- unauthorized
- invalid-token
- forbidden
- insufficient-permission
- approval-required
- untrusted-origin
- database-connect-forbidden
- installation-not-held
- forbidden-access
- invalid-access-code
- agent-cannot-approve
- approval-only-initiator-may-decide
- api-key-revoked
- not-found
- resource-not-found
- project-not-found
- environment-not-found
- service-not-found
- serviceenvironment-not-found
- deployment-not-found
- domain-not-found
- changeset-not-found
- instance-not-found
- installation-not-found
- repository-not-found
- region-not-found
- plan-not-found
- instance-size-not-found
- billing-plan-not-found
- billing-account-not-found
- invoice-not-found
- offering-not-found
- abuse-report-not-found
- agentsession-not-found
- approval-not-found
- backup-not-found
- bucket-not-found
- bucketconnection-not-found
- database-size-not-found
- invite-not-found
- member-not-found
- provider-not-found
- restore-not-found
- service-environment-not-found
- slot-not-found
- tunnel-not-found
- upload-batch-not-found
- user-not-found
- workspace-not-found
- conflict
- bucket-name-taken
- bucket-already-connected
- bucket-object-exists
- project-conflict
- environment-conflict
- service-conflict
- domain-conflict
- envvar-conflict
- offering-conflict
- instance-size-conflict
- provider-conflict
- invalid-deployment-state-transition
- invalid-instance-state-transition
- instance-quota-exceeded
- invalid-repo-url
- repo-unavailable
- invalid-installation-state
- installation-revoked
- backups-disabled
- backup-in-flight
- backup-not-restorable
- backup-held-by-restore
- backup-engine-version-unsupported
- bucket-not-ready
- bucket-provisioning
- bucket-key-missing
- bucket-suspended
- bucket-folder-deleting
- bucket-quota-reached
- bucket-upload-batch-closed
- bucket-upload-incomplete
- bucket-upload-not-open
- database-provisioning
- database-failed
- database-cap-blocked
- database-suspended
- database-stopped
- database-asleep
- tunnel-closed
- service-suspended
- provisioning-not-retryable
- exposure-ceiling-exceeded
- github-authorization-failed
- custom-domain-required
- ip-allowlist-while-private
- last-domain-custom-only
- approval-not-pending
- approval-operation-unknown
- plan-limit-exceeded
- plan-compute-cap-exceeded
- abuse-report-not-pending
- not-abuse-suspended
- account-suspended
- account-not-approved
- phone-not-verified
- account-standing
- card-required
- usage-limit-exceeded
- budget-cap-exceeded
- plan-size-not-allowed
- workspace-has-services
- workspace-last-undeletable
- internal-error
- bad-gateway
- service-unavailable
- auth-unavailable
- auth-directory-unavailable
- gateway-timeout
- error
- bucket-object-delete-failed
- tunnels-unavailable
- database-not-ready
- region-capacity-exhausted
- region-briefly-full
- logs-store-unavailable
- no-backup-destination
- backup-purge-failed
- github-connect-unconfigured
- access-control-not-enabled
- billing-not-enabled
- billing-service-unavailable
- mail-transport-failed