API reference · API 1.0.0

Operations

Long-running work: poll until succeeded or failed.

get /api/v1/operations/{operation_id}

One operation

Operation operations_get · bearer token

Long-running work started by a 202 answer, by its id <kind>:<native id> (the Location header of the 202). Poll it until status is succeeded or failed; awaiting_approval and awaiting_operator wait for a person in the portal. The kinds: provision (project provisioning), release (a release promotion), model-store-run (a model node cache or uncache) and order (a tenant order placed in the portal, which this API can poll but not create). Reading an operation never changes it. 404 operation_not_found for an id of an unknown kind, an unknown id, or one the caller may not see.

Parameters

NameInTypeDescription
operation_idrequired path string

Responses

  • 200

    The operation.

    application/json → Operation
    Headers: X-Request-ID
  • 401

    Not authenticated: no Authorization: Bearer header (not_authenticated), or the credential is refused (token_invalid, token_expired, token_revoked, principal_disabled, token_ip_not_allowed).

    application/jsonapplication/problem+json → Problem
    Headers: WWW-Authenticate, X-Request-ID
  • 403

    The caller lacks a permission the operation needs (forbidden; required lists the keys, any one of which would do), or the licence refuses a change (licence_locked, licence_restricted, licence_required, with state and remedy; never retry a licence_* code).

    application/jsonapplication/problem+json → Problem
    Headers: X-Request-ID
  • 404

    No such operation, or one the caller may not see (operation_not_found).

    application/jsonapplication/problem+json → Problem
    Headers: X-Request-ID
  • 429

    More than 600 requests in a minute with this token (rate_limited), or the first request with this Idempotency-Key is still running (idempotency_request_in_progress). Retry after Retry-After.

    application/jsonapplication/problem+json → Problem
    Headers: Retry-After, X-Request-ID
  • 503

    The platform cannot answer right now (unavailable; retry after Retry-After), or API tokens are not configured on it (api_tokens_unconfigured; an operator must act).

    application/jsonapplication/problem+json → Problem
    Headers: Retry-After, X-Request-ID
  • default

    Problem details (RFC 9457)

    application/jsonapplication/problem+json → Problem
    Headers: X-Request-ID

Rendered from openapi-v1.json, platform release 1.0.187. Your installation serves the contract of its own version at /api/v1/openapi.json.