Cloud Management Portal (CMP) API

The Cloud Management Portal (CMP) API is a RESTful HTTP API for programmatically managing every resource exposed by the cloud platform — compute instances, storage, networking, VPN, Kubernetes clusters, security policies, cost estimation, and billing.

Anything you can do in the CMP web console, you can automate through this API: launch and resize instances, attach volumes, create networks and load balancers, manage Kubernetes clusters, query usage, quotas and invoices, and estimate costs.

API version

This reference documents CMP API version 3.0.1 (OpenAPI 3.1.0). The API is licensed under Apache License 2.0.

---

Base URL

All requests are made to your provider's portal host over HTTPS:

https://portal.your-domain.com/restapi/<resource>/<operation>

Replace portal.your-domain.com with the hostname of your cloud provider's portal. Every endpoint in this reference is expressed as a path relative to that host — for example, POST /restapi/loadbalancerrule/createLoadBalancerRule.

note

The host shown throughout this documentation is a placeholder. Use the base URL supplied by your cloud provider.

---

How the API is organized

Endpoints are grouped by resource. Operations follow consistent naming:

Verb pattern	Purpose	Example
create<Resource>	Provision a new resource	createLoadBalancerRule
<resource>List	List resources visible to the account	networkList
update<Resource>	Modify an existing resource	updateNetwork
delete<Resource>	Remove a resource	deleteVolume

Browse the reference by group using the sidebar:

• Compute — instances, compute offerings, hosts, templates, SSH keys, VM snapshots
• Storage — volumes, storage offerings, snapshots, snapshot policies
• Networking — networks, VPCs, ACLs, IP addresses, load balancers, firewall / port-forwarding / egress rules, offerings
• VPN — VPN gateways, connections, customer gateways, remote-access users
• Security & Tagging — security groups and resource tags
• Kubernetes — cluster lifecycle
• Account & Billing — users, zones, usage, quotas, async job status, invoices
• Cost Estimate Analyzer — per-resource pricing and cost estimation

---

Quick start

1. Get your API credentials. Every request is authenticated with an API key and secret key sent as HTTP headers. See Authentication.
2. Choose an endpoint and note its HTTP method and required parameters.
3. Make the request, sending apikey and secretkey as headers along with the operation's parameters.

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

A successful call returns HTTP 200 with a JSON body. See Requests & Responses for the response envelope and Error Codes for failure handling.

---

Conventions used in this reference

Each endpoint page documents:

• the HTTP method and path,
• a parameters table (name, location, type, required, description),
• the request body schema where applicable,
• the response schema and a representative sample response,
• a runnable curl example.

tip

Parameters marked required must be present in every request. apikey and secretkey are required HTTP headers on all endpoints and are omitted from individual parameter tables for brevity — see Authentication.