Skip to content
Ocean6Documentation
DocsProtocol
Proposed specificationUpdated 19 Sep 2026

Errors and client recovery

On this page
Design status

This chapter specifies proposed network behavior. It is not a deployed service or a production API contract.

Use a stable machine-readable error code and a human-readable explanation. The proposed error envelope follows RFC 9457 Problem Details, with error_code and request_id extensions. Details must be sanitized and must not reveal another tenant's objects. [S3]

Swipe or scroll to view all columns →

HTTP statusConditionClient action
400Malformed encoding, JSON or duplicate member namesCorrect the request
422Well-formed request violates a supported contractInspect the field error and revise the input
401Missing or invalid authenticationObtain valid credentials through the supported flow
403Authenticated caller lacks permissionRequest the required scope
404Object absent or not visible to this callerCheck the identifier without inferring tenant existence
409Idempotency conflict, stale generation or invalid transitionRead authoritative state; resolve the conflict
429Rate limit exceededHonor Retry-After and use bounded backoff
503Temporary service or capacity unavailabilityRetry only within the task and budget policy

Illustrative error object#

JSON
{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key is bound to another request.",
  "error_code": "IDEMPOTENCY_CONFLICT",
  "request_id": "illustrative-request-id"
}

This object illustrates the draft format. Network error codes remain subject to contract approval. The local CLI error strings in the troubleshooting chapter are a separate reference interface.

Recovery without duplicate effects#

A timeout does not show whether the server committed a request. Recover with the original idempotency key or recorded task identifier. Retry delays should include jitter and a ceiling; a 429 or 503 response does not authorize exceeding a deadline or creating a second payment.

Preserve the request identifier and sanitized diagnostic context when escalating an error.

Documentation 1.1 · Software reference 0.2
Download PDFDeveloper packageWord editionView Markdown

Search across all 30 chapters.

Use Tab to navigate results and Enter to open a chapter.
Documentation v1.1 · EN
Open task lab ↗Ocean6 website ↗