Skip to content

Get an operation

  • Method: GET
  • Path: /v1/orgs/{org}/operations/{operation_id}
  • Operation ID: getOperation
  • Tag: Operations

Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.

Name Type Required Description
operation_id string (uuid) Yes
org string (uuid) Yes The organization’s id.
Field Type Required Enum Description
attempt integer Yes
created_at string (date-time) Yes
error_class string, nullable No
error_detail string, nullable No
finished_at string (date-time), nullable No When the operation reached a terminal state. Guaranteed non-null whenever state is succeeded, failed or cancelled – including operations that complete synchronously and are returned already succeeded. null means the operation is still in flight.
id string (uuid) Yes
max_attempts integer Yes
resource_id string Yes
resource_type string Yes
state string Yes
type string Yes

Every error response is application/problem+json (schema Problem).

Status Meaning
401 The credential is missing or invalid.
404 The resource does not exist.
default Any other status is possible; the code field identifies the error.
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/operations/$OPERATION_ID" \
  -H "Authorization: Bearer $VIRTSCALE_API_KEY"