Skip to main content
GET
Get Operation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

operation_id
string
required

The id of an operation returned in a 202 response. It is opaque, so don't decode it or build one yourself.

Response

Successful Response

id
string
required

Opaque operation identifier. Poll GET /v1/operations/{id} with it; do not decode or construct it.

done
boolean
required

Whether the operation reached a terminal state. While false, neither result nor error is set; when true, exactly one of them is.

result
Result · object | null

Operation output on success. Shape depends on the operation kind.

error
OperationError · object | null

Terminal failure details. Set only when done and the operation failed.

metadata
Metadata · object | null

Operation kind and launch context (e.g. type, the resource it runs against). Informational; keys may be added over time.