Errors Beta

One error shape on every route

Beta. This endpoint is live for design partners, with keys that Dopl issues while the developer portal is being built.

{
  "error": {
    "type": "device_error",
    "code": "device_offline",
    "message": "No target device is online.",
    "retryable": true,
    "doc_url": "https://www.usedopl.com/docs/errors/device-offline"
  }
}

device_kind appears when one device is involved. Retry only when retryable is true, with the same idempotency key. The Request-Id header identifies the call.

Codes

CodeHTTPTypeRetryableMeaning
device_offline409device_errorYesNo target device is online
capability_unsupported422invalid_request_errorNoThe device does not publish this capability, or its profile does not allow it
grant_missing403permission_errorNoThe user has not granted this capability at this tier
grant_expired403permission_errorNoThe grant has expired
confirmation_denied403permission_errorNoThe profile denies this tier, which is the default for T4
rate_limited429rate_limit_errorYesToo many requests for this project and environment
vendor_error502device_errorYesThe vendor's service failed, or delivery to this kind of device is not available yet
needs_reauth409permission_errorNoThe user must reconnect the device
invalid_request400invalid_request_errorNoThe request does not match the contract, or a token is invalid or used
unauthenticated401authentication_errorNoThe key is missing, unknown, revoked or expired
insufficient_scope403permission_errorNoThe key's scopes do not cover this route, or a publishable key called a secret key route
not_found404invalid_request_errorNoNo such user, device, connection or action
idempotency_conflict409invalid_request_errorNoThe idempotency key was already used with a different body