Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Poll a long-running operation
Fetches the current state of a long-running operation previously returned by any 202 (async) write anywhere in the API — instance creation, cluster upgrade, volume resize, failover drills and so on. The Operation records the canonical action id, the target resource kind/id, a state machine value, optional progress and, on failure, the same ApiError envelope the synchronous path would have produced. Clients poll this endpoint as a fallback when the SSE stream is unavailable. Validation: operationId must reference an operation visible to the caller's scopes — an unknown id, or one belonging to a tenant the caller cannot read, maps to 404 ErrNotFound (existence is not disclosed across tenants). Async & state: Synchronous read; no state change. The underlying operation itself progresses PENDING → RUNNING → SUCCEEDED | FAILED | CANCELLED, and each transition is also pushed as a resource.updated SSE frame with kind 'operation' and a patch containing at least { state }, plus frames for the target resource as it changes. Errors: 401 unauthenticated; 403 when the caller is authenticated but lacks read access to the operation's scope; 404 unknown or invisible operationId; 500 internal. Idempotency/Concurrency: Safe, cacheable; no idempotency key required. Terminal operations (SUCCEEDED/FAILED/CANCELLED) are immutable and retained for at least 24h.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
operationId*stringIdentifier returned in the Operation body (or Location header) of a 202 response.
The operation in its current state.
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"resourceKind?|Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.
resourceId?|Identifier of the target resource; null until the resource is allocated.
resourceName?|Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).
principalId?|Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.
sourceIp?|Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).
progressPercent?|Best-effort progress; null when the action does not report progress.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.
startedAt?|When the worker began executing; null while PENDING.
finishedAt?|When a terminal state was reached; null while transitional.
createdAt*stringupdatedAt*stringcurl -X GET "https://example.com/operations/string"{ "id": "string", "action": "string", "state": "PENDING", "resourceKind": "string", "resourceId": "string", "resourceName": "string", "principalId": "string", "sourceIp": "string", "progressPercent": 0, "error": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "warning": { "code": "string", "message": "string", "field": "string", "details": {}, "retryable": false }, "startedAt": "string", "finishedAt": "string", "createdAt": "string", "updatedAt": "string"}