Skip to navigation

Get operation status

Returns the status of an async compute operation (create, delete, start, stop, reboot). Works for both cloud VM and GPU VM operations. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# OPERATION_ID: Operation ID returned by a create, delete, or power-action request
curl "https://api.ibee.ai/v1/compute/operations/$OPERATION_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

operation_idstringRequired

Operation ID returned by a create, delete, or power-action request.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Operation returned successfully.
operation_idstring
ID of the operation.
vm_idstring
ID of the VM the operation acts on.
actionenum

What the operation does.

  • create, delete: create or delete the VM.
  • start, stop, reboot: power actions.
  • resize, resize_plan, resize_root_disk: change the shape or the root disk.
  • attach_volume, detach_volume: block volume attachment.
  • update_access: SSH key or password change.
  • snapshot, restore: snapshot or restore.
  • rebuild, rescue: rebuild the VM or boot it into rescue mode.
statusenum
  • accepted: queued, not started.
  • running: in progress.
  • waiting: paused until an external step completes.
  • compensating: rolling back after a failure.
  • succeeded: finished successfully.
  • failed: finished with an error; see error_code and error_message.
  • cancelled: stopped before completion.
  • timed_out: did not finish within the allowed time.
submitted_atdatetime

When the operation was accepted (ISO 8601).

updated_atdatetime

When the status last changed (ISO 8601).

current_stepstring or nullOptional
Name of the step currently running, when the workflow reports one.
error_codestring or nullOptional

Machine-readable error code when status is failed.

error_messagestring or nullOptional

Human-readable error detail when status is failed.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error