API tokens and the API
The portal has a REST API for everything you do with instances, plus billing and your organization's records. Scripts, Terraform-style tools and monitoring systems sign in to it with an API token.
The API reference lists every call with its fields, and lets you try them with your token. Tools that read OpenAPI can load the whole API from /api/v1/openapi.json.
To let an AI assistant such as Claude, Cursor or VS Code use the portal with a token, see AI assistants (MCP).
Create a token
- Open API tokens under Account in the sidebar. You are asked for your password first.
- Enter a name that says where the token is used, e.g. "Backups script on build server".
- Choose the access:
- Read only: list and view instances, catalog, usage, backups, billing, members and the audit log. Any change is refused with
403. - Read and write: also create, change and delete.
- Read only: list and view instances, catalog, usage, backups, billing, members and the audit log. Any change is refused with
- Choose when it expires: in 30, 90 or 365 days, or never. Prefer an expiry; you can always create a new token.
- Select Create token and copy the token now. It is shown only once; the portal stores only a fingerprint of it.
A token acts as you: it can do in each organization only what your role there allows (see Members and roles). If your role changes or you leave an organization, your tokens change with it.
Revoke a token
Select Revoke next to it. Requests using it are refused at once. The list shows when each token was last used, so you can spot ones nobody needs. Creating and revoking tokens is recorded in your account's activity.
If a token may have leaked, revoke it and create a new one.
Calling the API
Send the token in the Authorization header and ask for JSON:
curl https://<portal address>/api/v1/organizations \
-H "Authorization: Bearer 12|AbCdEf..." \
-H "Accept: application/json"
- Every address starts with
/api/v1. Requests and responses are JSON; send bodies withContent-Type: application/json. - Lists of things your organization owns are under
/api/v1/organizations/{id}/…. Get the IDs fromGET /api/v1/organizations. - Errors:
401missing, wrong or expired token;403your role or a read-only token does not allow it;404not found in that organization;422invalid input (details undererrors);429too many requests (wait a moment);503the provider could not be reached. - Changes the provider applies only after the instance is shut down and started answer with
"meta": {"applies_on_boot": true}.
Endpoints
Account and organizations
| Method and address | What it does |
|---|---|
GET /user |
The signed-in user. |
GET /organizations |
Organizations you belong to, with your role. |
GET /organizations/{id}/members |
Members and their roles. |
GET /organizations/{id}/audit-log |
The audit log, newest first, 50 per page (?page=2). |
Catalog and instances (all under /organizations/{id})
| Method and address | What it does |
|---|---|
GET /catalog |
Regions, sizes (with prices) and images you can order. |
GET /instances |
Instances, 100 per page; filter with ?project_id= and ?tag=. |
POST /instances |
Create one: hostname, region_id, size_id, image_id, root_password, optional ssh_key or ssh_key_ids, project_id, tags. |
GET /instances/{instance} |
One instance, including size_id and rescue_mode. |
PATCH /instances/{instance} |
Change its project_id and tags. |
POST /instances/{instance}/actions |
Power: {"action": "start" | "stop" | "reboot" | "power_off"}. |
PUT /instances/{instance}/hostname |
{"hostname": "web-1.example.com"}. |
PUT /instances/{instance}/root-password |
{"root_password": "..."}; never stored by the portal. |
GET /instances/{instance}/usage |
CPU, memory, disk and this month's traffic. |
POST /instances/{instance}/resize |
{"size_id": 12}; the disk can only grow. |
POST /instances/{instance}/rescue |
Start rescue mode with {"root_password": "..."}. |
DELETE /instances/{instance}/rescue |
End rescue mode. |
POST /instances/{instance}/reinstall |
image_id, root_password, optional SSH key. Erases the disk. |
DELETE /instances/{instance} |
Delete the instance and its disk. |
Backups (under /organizations/{id}/instances/{instance})
| Method and address | What it does |
|---|---|
GET /backups |
Backups, newest first, and whether backups are on (meta.enabled). |
PUT /backups |
Turn paid backups on or off: {"enabled": true}. |
POST /backups |
Take a backup now (answers 202). |
POST /backups/restore |
{"backup": "<id from the list>"}. Overwrites the disk. |
DELETE /backups |
{"backup": "<id>"}. |
Projects and SSH keys (under /organizations/{id})
| Method and address | What it does |
|---|---|
GET, POST /projects; PUT, DELETE /projects/{project} |
See Projects and tags. |
GET, POST /ssh-keys; DELETE /ssh-keys/{key} |
See SSH keys. |
Support (under /organizations/{id})
| Method and address | What it does |
|---|---|
GET /support-tickets |
Your organization's tickets, latest activity first, 50 per page; filter with ?status=open, answered (waiting for you) or closed. |
POST /support-tickets |
Open one: subject, category (technical, billing, account, other), priority (low, normal, high, urgent), body, optional instance_id. Answers 201 with the ticket. |
GET /support-tickets/{ticket} |
One ticket with its messages (from_support marks support's replies). |
POST /support-tickets/{ticket}/replies |
{"body": "..."}; reopens a closed ticket. |
POST /support-tickets/{ticket}/close |
Close it. |
See Support tickets.
Billing (under /organizations/{id}; needs a role that can see billing)
| Method and address | What it does |
|---|---|
GET /wallet |
Balance, current hourly cost, hours left and unused credits. Amounts are strings in the wallet's currency. |
GET /wallet/transactions |
Top-ups, credits and hourly charges (negative), newest first, 50 per page. |
POST /coupons |
Redeem a coupon: {"code": "WELCOME500"}. |
GET /plan |
Your plan, limits, usage and any scheduled change (when plans are in use). |
PUT /plan |
Change plan: {"plan_id": 2}. See Plans. |
| GET /licenses | Licences for self-hosted installations (Owners and Admins). |
| GET /licenses/{licence}/key | The signed licence key, as text. |
GET /api/v1/plans lists the plans you can choose.
If your plan has no API access, calls under /organizations/{id} answer 403 and explain why.
Migrations (under /organizations/{id})
| Method and address | What it does |
|---|---|
GET /migrations |
Server migrations, newest first, 50 per page, with status, progress and warnings. |
POST /migrations |
Start one: source_provider (e.g. aws, gcp, azure, digitalocean, other), source_name, destination_instance_id, mode (live or cold) and confirm_replace: true. Optional: source_start: "login" with source_host, source_port, source_user, source_auth (password or key) and source_password or source_private_key to have the portal start the source agent; prepare_destination: true; auto_reboot: true; dns_provider (cloudflare or digitalocean) with dns_token, dns_zone and dns_records (e.g. "@ www"); bandwidth_limit_mbps (1–100000 Mbit/s; omit for no limit). The response holds the agent commands (destination is null when the portal prepares it). |
GET /migrations/targets?instance_id= |
Where a one-click migration of that instance can go (targets: your cloud accounts that can create servers, and catalog for this platform's servers). With &target=own:{id} or &target=catalog, also that target's regions, sizes (fits the source) and images (matches its release). |
POST /migrations/one-click |
Move an instance to another cloud: source_instance_id, target, region_id, size_id, image_id, mode, confirm_create: true; optional name, quiesce, replace_ip, auto_reboot (all true by default), bandwidth_limit_mbps and source_start (auto or command). For sources the provider can't start the agent on, add the one-time login fields (source_host, source_port, source_user, source_auth, source_password or source_private_key); it is never stored or returned. |
GET /migrations/{migration} |
One migration; includes the agent commands while it runs, for roles that can manage it. |
POST /migrations/{migration}/actions |
{"action": "sync" | "finish" | "cancel"} (answers 202). With finish, optionally stop_services (names the source reported; without it a one-click migration stops all of them), replace_ip and finish_at (ISO 8601) to finish later. With cancel, delete_destination: true also deletes the server a one-click migration created. launch takes with_login: true and the login fields to start the agent with a login this once. launch, destination and dns have the portal start the source agent, prepare the destination or switch DNS again. Responses include automation, each step's state. See Migrate a server. |
PUT /migrations/{migration}/bandwidth |
{"bandwidth_limit_mbps": 50} changes how much of the source's network the copy may use (Mbit/s; null removes the limit). The source agent applies it within seconds; a running pass restarts with it. |
DELETE /migrations/{migration} |
Remove a finished or cancelled migration (else 409). |
Connectors (under /organizations/{id}; Owners and Admins)
| Method and address | What it does |
|---|---|
GET /connectors |
Connectors, with whether each is online. |
POST /connectors |
{"name": "Office"}. The response holds the agent's token, shown only this once. |
DELETE /connectors/{connector} |
Delete one that no cloud account uses (else 409). |
Notifications (under /organizations/{id}; Owners and Admins)
| Method and address | What it does |
|---|---|
GET /notification-channels |
Channels, with their events and last result. Webhooks include their signing_secret. |
POST /notification-channels |
Add one: name, type (webhook, email, slack, discord, telegram, whatsapp), events (list of event keys) and the type's field: webhook_url, emails (list), slack_url, discord_url, chat_id and optional bot_token, or phone. Optional is_enabled. |
PUT /notification-channels/{channel} |
Change it; same fields. Leave slack_url, discord_url or bot_token out to keep the saved one. |
DELETE /notification-channels/{channel} |
Delete it and its message history. |
POST /notification-channels/{channel}/test |
Send a test message (answers 202). |
GET /notification-channels/{channel}/deliveries |
Messages sent in the last 30 days, newest first, 50 per page. |
Event keys and the webhook format are in Notifications and webhooks.
The browser console and the provider panel sign-in are only available on the instance page, because they open a live session on your server.