Compute Offering

Compute offerings define the CPU, memory and clock-speed profile available when launching an instance.

Resource base path: /restapi/compute

Method	Path	Description
GET	/restapi/compute/computeOfferingList	Compute Offering List
GET	/restapi/compute/computeOfferingListWithPrice	Compute Offering List With Price

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Compute Offering List

List the compute offerings available in a zone.

GET /restapi/compute/computeOfferingList

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	✅ Yes	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/compute/computeOfferingList?zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "listComputeOfferingResponse": [
    {
      "displayText": "string",
      "memory": "string",
      "clockSpeed": "string",
      "name": "example-name",
      "storageType": "string",
      "numberOfCores": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "count": 1
}

---

Compute Offering List With Price

List compute offerings including per-zone pricing.

GET /restapi/compute/computeOfferingListWithPrice

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	No	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/compute/computeOfferingListWithPrice" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listComputeOfferingPriceResponse": [
    {
      "displayText": "string",
      "memory": "string",
      "clockSpeed": "string",
      "price": [
        {}
      ],
      "name": "example-name",
      "isCustom": true,
      "storageType": "string",
      "numberOfCores": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}