MethodPathSummaryAuth
GET/v1/admin/cache-operation-requests/{idempotency_key}What the server did with a cache write sent with this Idempotency-KeySession

Contract file:api/control-cache-operations.openapi.yaml

Operation details

GET /v1/admin/cache-operation-requests/{idempotency_key}

What the server did with a cache write sent with this Idempotency-Key

operationId
getPlatformCacheWriteReceipt
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of:sites.read

Description (from the contract)

For a write whose response was lost (network, timeout, 5xx): accepted with the operation (the new one of a create or re-submit), or rejected with the error code the write was refused with. 404 means the server has no record of the key for the authenticated actor in the scope: the write was not received and may be sent again with the same key and body. Another actor's key is the same 404 (existence is never disclosed). Not-found and permission refusals of the write itself are not kept and also read as 404. Writes nothing.

Parameters

getPlatformCacheWriteReceipt Parameters
NameInTypeRequiredDescription
idempotency_keypathstringYesThe Idempotency-Key the write was sent with (the batch key of a re-submit).
actionquerystring: create / retry / cancel / resubmitYes—
operation_idquerystring(uuid)NoThe operation a retry, cancel or re-submit acts on; required for those, absent for create.
scope_idquerystring(uuid)YesExplicit active tenant scope; platform scope is never implied.
X-Request-IDheaderstringYes—

Responses

getPlatformCacheWriteReceipt Responses
StatusDescription
200The write was decided.

Fields:status: string: accepted / rejected decided_at: string(date-time) operation?: object rejection?: object

400Invalid or non-canonical request.
401Authentication required.
403Exact cache permission is absent or route audience is wrong.
404Resource is absent or outside the effective tenant scope.
408Request context was cancelled or exceeded its deadline.
503A required store is unavailable; raw dependency errors are never returned.

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list