Error codes

Branch on code, never on title or detail. New codes can be added within v1, so treat a code you don't recognise by its HTTP status. See Errors for the response shape.

• 400
  invalid_request

  malformed JSON, unknown query parameter value or wrong type.

• 400
  invalid_cursor

  the cursor is malformed or expired.

• 400
  organisation_header_required

  an OAuth caller omitted Vojo-Organisation.

• 400
  unsupported_api_version

  Vojo-Version is not a known version date.

• 401
  unauthenticated

  no credential was sent.

• 401
  invalid_token

  the access token or secret key is invalid, expired or revoked.

• 402
  entitlement_limit_reached

  the org's plan does not allow more of this feature (feature_key, limit, used).

• 402
  storage_quota_exceeded

  the upload would exceed the org's storage quota (limit, used).

• 403
  insufficient_scope

  the token/key lacks the operation's required scope.

• 403
  permission_denied

  the user lacks the required Permissions flag in the active org.

• 403
  operator_access_required

  client / installer personas cannot use network endpoints.

• 403
  organisation_access_denied

  the caller has no access to the org in Vojo-Organisation, or a secret key's header does not match its org.

• 404
  not_found

  the resource does not exist or belongs to another organisation (never 403, to avoid leaking existence).

• 409
  duplicate_name

  a resource with this name already exists in the org.

• 409
  harvester_already_assigned

  the harvester is already paired to another screen.

• 409
  screen_already_paired

  the screen already has a different device paired.

• 409
  no_quality_readings

  the screen has no quality readings to calibrate from yet.

• 409
  idempotency_key_reused

  the Idempotency-Key was used with a different request body.

• 409
  idempotency_request_in_progress

  a request with this Idempotency-Key is still being processed.

• 409
  delivery_not_retryable

  The delivery is pending, succeeded or was skipped, or its endpoint is not active, so it can't be retried.

• 413
  payload_too_large

  the declared upload size exceeds the per-object maximum (2 GB).

• 422
  validation_failed

  one or more fields failed validation; see errors[].

• 422
  upload_not_found

  the referenced upload does not exist, is not this org's, or was never PUT.

• 422
  upload_mismatch

  the stored object does not match what was declared (size or content type).

• 429
  rate_limited

  too many requests; retry after Retry-After seconds.

• 500
  internal_error

  unexpected server failure. Safe to retry idempotent requests.