Skip to navigation

List compute images

Lists ready public OS images compatible with cloud or GPU VMs. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/compute/images?workspace_id=$WORKSPACE_ID&vm_type=cloud" \
-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.

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.

vm_typeenumRequired

Kind of VM the images are for. Required.

  • cloud
  • gpu
Allowed values:
site_idstringOptional>=1 character

Optional exact placement filter. Copy site_id from GET /compute/sites.

Response

Compute images returned successfully.
imageslist of objects
Images matching the request.
countinteger>=0

Number of items in images.

vm_typeenum

Kind of virtual machine.

  • cloud: general-purpose cloud VM.
  • gpu: VM with attached GPUs.
Allowed values:
site_idstring or nullOptional
Site filter that was applied, when one was given.

Errors

400
Bad Request Error
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