CMP

API reference

API tokens → API reference lists every call of the portal's API, grouped like the menu: account, instances, backups, projects and SSH keys, billing, migrations, connectors, notifications, support and licences. For each call it shows:

Try a call

  1. Create a token under API tokens and paste it into API token at the top. Use a read-only token if you only want to look.
  2. Enter your Organization ID (call Organizations you belong to first if you don't know it). It is filled into every {organization} in the addresses.
  3. On a call, select Try it, fill in any other IDs, query fields or the JSON body, and select Send request. The answer and its HTTP status appear below.

The token stays in this browser tab only and is sent only to this portal. It is forgotten when you close the tab.

Calls are real. Creating, resizing or deleting an instance from this page really does it, and costs money like any other order.

Copy as curl copies the call as a curl command for a terminal. It uses $CMP_TOKEN instead of your token, so set that variable first: export CMP_TOKEN='12|AbCdEf…'.

OpenAPI

The same reference is available as an OpenAPI 3.1 document at /api/v1/openapi.json on your portal's address (OpenAPI (JSON) at the top of the page). Load it into Postman, Insomnia or a code generator to get a ready-made client. It doesn't need a token.