Skip to navigation

List compute plans

Lists billable cloud or GPU VM plans. 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/plans?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 plans are for. Required.

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

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

currencystringOptional=3 charactersDefaults to INR

ISO 4217 code of the currency to quote prices in. Default INR.

billing_intervalenumOptionalDefaults to MONTHLY

Billing period to quote prices for.

  • HOURLY
  • MONTHLY (default)
Allowed values:
include_availabilitybooleanOptional

Check advisory placement by default when site_id is supplied. Set false for pricing-only discovery. This does not reserve stock.

os_typeenumOptionalDefaults to linux

OS pool to check when include_availability is true.

Allowed values:
requires_public_ipbooleanOptionalDefaults to true
Include public IPv4 capacity in the advisory placement check.

Response

Compute plans returned successfully.
planslist of objects
Plans matching the request.
countinteger>=0

Number of items in plans.

vm_typeenum

Kind of virtual machine.

  • cloud: general-purpose cloud VM.
  • gpu: VM with attached GPUs.
Allowed values:
currencystring
ISO 4217 code of the currency the prices are quoted in.
billing_intervalenumDefaults to MONTHLY

Billing period a price is quoted for.

  • HOURLY: price per hour of running time.
  • MONTHLY: price per calendar month (default).
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