Network Offering

Network offerings define the feature set and services available to a network.

Resource base path: /restapi/networkoffering

Method	Path	Description
GET	/restapi/networkoffering/networkOfferingList	Network Offering List
GET	/restapi/networkoffering/vpcNetworkOfferingList	VPC Network Offering List

note

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

---

Network Offering List

Network Offering List.

GET /restapi/networkoffering/networkOfferingList

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/networkoffering/networkOfferingList?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.

{
  "count": 1,
  "listNetworkOfferingResponse": [
    {
      "displayText": "string",
      "offerName": "example-name",
      "name": "example-name",
      "availability": "string",
      "guestIpType": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkTrialOffering": true
    }
  ]
}

---

VPC Network Offering List

VPC Network Offering List.

GET /restapi/networkoffering/vpcNetworkOfferingList

Parameters

Parameter	In	Type	Required	Description
uuid	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/networkoffering/vpcNetworkOfferingList" \
  -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,
  "listNetworkOfferingResponse": [
    {
      "displayText": "string",
      "offerName": "example-name",
      "name": "example-name",
      "availability": "string",
      "guestIpType": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "networkTrialOffering": true
    }
  ]
}