API reference
Manage your servers with our API.
Deploy, resize and manage compute, storage and IP addresses from your own code. What you can do in the control panel, your code can do too, using a single API key.
- REST + JSON
- Bearer token auth
- No pagination limits
$ curl https://iotamine.com/api/vps/ \ -H "Authorization: Bearer YOUR_API_KEY"
{
"count": 1,
"results": [{
"id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90",
"hostname": "web-01", "machine_status": "Running",
"cores": 4, "ram": 8, "primary_disk": 160,
"vps_city": "Frankfurt",
"ip_address": [{ "ip": "198.51.100.42" }]
}]
}Authentication
API keys
Every request is authenticated with an API key sent in the Authorization header. There's no request signing. Generate a key from the dashboard and send it with every request. The older Authorization: Api-Key YOUR_API_KEY form still works. Building an app that other people sign in to? Use OAuth instead of asking them for a key.
Authorization: Bearer YOUR_API_KEY
Create keys under Infrastructure → API Keys in the control panel. A key looks like iota_… and is shown only once, when you create it, so store it somewhere safe straight away (a password manager or your CI's secret store). It can't be shown again; if you lose it, create a new one. Keys created before this format keep working.
When you create a key you choose when it expires: after 30, 90 (the default) or 365 days, or never. Pick the shortest that works for the job, and create a new key before the old one runs out.
You can lock each key to a single source IP. Set allowed_ip and requests from any other address are rejected before authentication runs.
Each key can make 120 requests per minute. Past that you get a 429 with a Retry-After header saying how many seconds to wait before trying again.
Creating a VPS, creating a volume and buying IP addresses accept an Idempotency-Key header (any unique string you choose, such as a UUID). Retry with the same key and the same body and you get the first result back instead of paying twice. The same key with a different body returns 409.
API responses never include a server's root password. You can reveal it only in the dashboard.
Each key has one of three scopes. Actions that change something use POST, including power actions and the console. Treat a key like a password, and revoke it (set it inactive or delete it) as soon as you no longer need it.
read_onlySees everything your account owns, but any request other than GET/HEAD/OPTIONS gets a 403.read_writeCan also create, change and delete everything your account owns. Because it can reinstall a server, swap its boot disk or move its volumes to another server, treat it as able to get root on your servers and the data on them.fullEverything Read & write can do, plus running commands and reading or writing files inside a server, opening a console, and setting a root password or SSH keys on a server, including when you reinstall it.VPS ids are UUID strings, like "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90". IP address, volume, SSH key and ticket ids are plain integers.
Almost every endpoint accepts an API key. Compute, storage, IP, billing, invoices, transactions, support tickets, account profile and reference endpoints all do (marked API key on this page). Only adding funds, payment-gateway/currency lookups, trusted IPs and API-key management need a dashboard session (see Dashboard-only endpoints). A key also can't create or manage other keys. For that you always need to be logged into the dashboard.
OAuth
OAuth for apps
If your app acts for other Iotamine users, let them sign in and approve it instead of pasting a key. This is how AI apps connect to our MCP server.
- Authorization code flow with PKCE (S256), as in OAuth 2.1. Apps can register themselves with dynamic client registration. Every endpoint is listed in the metadata at https://iotamine.com/.well-known/oauth-authorization-server.
- The person signing in chooses the scope on the consent screen: Read-only by default, or one of the other two levels above.
- Access tokens last 1 hour (expires_in in the token response). Send one exactly like an API key: Authorization: Bearer <token>.
- Refresh tokens last 30 days and change every time you use one: POST grant_type=refresh_token with the current refresh token, then store the new one you get back. The old one stops working.
- Revoke a token with POST /api/oauth/revoke/ (RFC 7009). The person can also remove the app's access from API Keys in the dashboard.
curl https://iotamine.com/.well-known/oauth-authorization-server
Quickstart
List your VMs in one request
curl https://iotamine.com/api/vps/ \ -H "Authorization: Bearer YOUR_API_KEY"
This endpoint is paginated (5 per page by default). See the response shape under VPS below, or add ?page_size=100 to get more results at once.
Compute
VPS
Full lifecycle for your virtual machines — deploy, resize, power control, console access, backups, and the disks/IPs bundled onto one.
VPS ids are UUID strings. Responses never include the root password; reveal it in the dashboard if you need it.
/api/vps/paginatedAPI keyList every VPS you own — paginated, 5 per page by default.
Query params
searchstringFilter by hostname/IP.pageintPage number.page_sizeintResults per page — up to 100000, so a large value effectively disables pagination.Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [
{
"id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "hostname": "web-01", "status": "active",
"machine_status": "Running", "cores": 4, "ram": 8,
"primary_disk": 160, "traffic": 5, "hourly_rate": 0.0248,
"vps_country": "Germany", "vps_city": "Frankfurt",
"os_name": "ubuntu", "ip_address": [
{ "id": 88, "ip": "198.51.100.42", "is_primary": true }
],
"is_building": false, "is_failed": false,
"created_at": "2026-07-02T10:15:00Z"
}
]
}/api/vps/API keyDeploy a new VM — a fresh disk + OS template, or booted from an existing volume you already own. Send an Idempotency-Key header so a retried request can't create a second server.
Request body
hostname *stringServer display name.password *stringRoot/administrator password.pop *intRegion id (see GET /api/pop/).cores *intvCPU count: 1, or any even number up to 64.ram *intRAM in GB: any even number from 2 to 128.diskintBoot disk size in GB. Required unless existing_boot_volume is set.operating_systemintOS template id (see GET /api/os/). Required unless existing_boot_volume is set.existing_boot_volumeintA volume you already own — boots the VM from it instead of provisioning a fresh disk.existing_ipintAn IP address you already own — used instead of auto-assigning a new one.ssh_keyintOne of your saved SSH key ids.disable_pwd_authboolDisable SSH password login (key-only).Example response · 201
{
"id": "b6e2d8f1-4a3c-4e7b-8d2f-9c1a5e6b3d47", "hostname": "web-02", "status": "active",
"cores": 4, "ram": 8, "primary_disk": 160,
"vid": "e41a07c3...", "created_at": "2026-08-17T09:00:00Z"
}/api/vps/{id}/API keyRetrieve one VPS, including a live-checked machine_status.
Example response · 200
{ "id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "hostname": "web-01", "machine_status": "Running", "...": "..." }/api/vps/{id}/API keyResize (cores/ram — must be one of the allowed tier values) or change hostname/password. Hostname and password changes require the VPS to be stopped first. Setting the root password needs a key with Read, write & run commands access; a Read & write key gets a 403 for it.
Request body
coresintNew vCPU count.ramintNew RAM in GB.hostnamestringNew hostname — requires the VPS to be stopped.passwordstringNew root password — requires the VPS to be stopped.Example response · 200
{ "id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "cores": 8, "ram": 16, "...": "..." }/api/vps/{id}/API keyDestroy a VPS (dispatches an async terminate task). Owned disks/IPs survive detached by default — list ids you want released instead.
Request body
release_ip_idsint[]Owned IPs to fully release (not just detach) along with the VPS.release_disk_idsint[]Owned volumes to fully release along with the VPS.Example response · 204
{ "message": "VPS deleted successfully." }/api/vps/{id}/start/ · stop/ · restart/ · poweroff/API keyPower actions — synchronous, no request body. Needs a Read & write key. These used to be GET requests; an API key calling them with GET now gets a 403, so switch to POST. Blocked while a backup/restore task is already running.
Example response · 200
{ "message": "VPS started successfully." }/api/vps/{id}/vnc/API keyOpen a browser console session — no request body. A console needs a key with Read, write & run commands access; GET is refused for API keys. Returns a WebSocket URL (and password, Virtualizor nodes only).
Example response · 200
{ "ws_url": "wss://iotamine.com/control/websockify/8123", "password": null }/api/vps/{id}/stats/API keyLive usage, cached for about 10 seconds. used_cpu is a percentage (0–100) across all of the server's vCPUs, measured from the host, so it includes a little virtualization overhead and can read slightly higher than top inside the server. ram and used_ram are in MB; disk, used_disk, bandwidth (this month's allowance) and used_bandwidth are in GB; net_in and net_out are the current network throughput in bits per second. usage is this server's unbilled compute cost so far.
Example response · 200
{
"used_cpu": 12.4, "cores": 4,
"ram": 8192, "used_ram": 2048,
"disk": 160, "used_disk": 18.42,
"bandwidth": 5120, "used_bandwidth": 340.5,
"net_in": 1843200, "net_out": 921600,
"pop_pricing": { "cpu": 0.004, "ram": 0.00035, "disk": 0.00002, "ip": 1.6 },
"usage": { "total_cost": 4.2, "hours_used": 170 }
}/api/vps/{id}/metrics_history/API keyStored CPU, RAM, network and disk samples for graphing, one per minute, up to 7 days back. cpu_pct is the same host-measured 0–100 figure as used_cpu above. ram_mb is the server's total RAM, so ram_used_mb / ram_mb gives memory use. A sample field can be null for a minute that wasn't measured. available is false when history isn't recorded for this server.
Query params
hoursnumberHow far back to go. Default 1, up to 168 (7 days).Example response · 200
{
"available": true, "hours": 1, "cores": 4, "ram_mb": 8192,
"samples": [
{ "timestamp": "2026-08-17T09:00:00Z", "cpu_pct": 12.4,
"ram_used_mb": 2048, "net_rx_bps": 1843200, "net_tx_bps": 921600,
"disk_read_iops": 3, "disk_write_iops": 11, "disk_used_mb": 18862 }
]
}/api/vps/{id}/bandwidth_history/API keyData transferred per day, in GB. Defaults to the current month so far.
Query params
start / enddateYYYY-MM-DD, both optional, both required if either is given. Up to 366 days, and end can't be in the future.Example response · 200
{
"available": true, "start": "2026-08-01", "end": "2026-08-17",
"daily": [ { "date": "2026-08-17", "rx_gb": 12.304, "tx_gb": 3.118, "total_gb": 15.422 } ]
}/api/vps/{id}/billing/ · getpricing/API keyThis VM's current billing breakdown, and its live hourly rate at the current spec.
Example response · 200
{ "hourly_rate": 0.0248, "monthly_estimate": 17.86 }/api/vps/{id}/rebuild/API keyReinstall the OS, wiping the boot disk. Requires the VPS to be stopped first. Because it sets a new root password, it needs a key with Read, write & run commands access; a Read & write key gets a 403.
Request body
osid *intOS template id to install.new_pass *stringNew root/administrator password.conf_pass *stringMust match new_pass.Example response · 200
{ "message": "VPS rebuild has been started with Ubuntu 24.04." }/api/vps/{id}/available_os/API keyOS templates installable on this VPS's region/node.
Example response · 200
[ { "id": 3, "name": "Ubuntu 24.04", "distro": "ubuntu" } ]/api/vps/{id}/build_log/API keyTail-pollable step-by-step provisioning log (regional-backed nodes only).
Query params
afterstringCursor from the previous poll — omit for the first call.Example response · 200
{ "entries": [ { "step": "Allocating disk", "status": "done" } ], "cursor": "18" }/api/vps/{id}/listbackup/ · getbackupcost/API keyList existing backups and their storage cost. Backups are supported on Virtualizor-backed nodes only — regional-backed VMs return a 400 explaining this.
Example response · 200
[ { "id": 9, "created_at": "2026-08-01T00:00:00Z", "size_gb": 40 } ]/api/vps/{id}/createbackup/ · restorebackup/ · deletebackup/API keyCreate a new backup, or restore/delete an existing one (restorebackup and deletebackup take backup_id). Async — dispatches a task.
Request body
backup_idintRequired for restorebackup and deletebackup.Example response · 200
{ "message": "Restore process has been started." }/api/vps/{id}/list_disk/ · add_disk/ · delete_disk/{disk_uuid}/API keyBundled disk management. add_disk/delete_disk are blocked (400) on regional-backed VMs — use the standalone Volumes endpoints below instead for those.
Example response · 200
{ "message": "Use the Volumes page to manage disks on this VM." }/api/vps/{id}/add_ip/ · delete_ip/{ip_addr}/API keyBundled IP management — same regional restriction as add_disk above; use the standalone IP Addresses endpoints for regional-backed VMs.
Example response · 200
{ "message": "IP added." }/api/vps/{id}/attachable_ips/API keyYour own unattached IPs eligible to attach to this VPS.
Example response · 200
[ { "id": 91, "ip": "198.51.100.7" } ]/api/vps/{id}/ip_address/{ip}/API keySet reverse DNS (rDNS) for one of this VPS's addresses.
Request body
rdns *stringThe hostname to point rDNS at.Example response · 200
{ "message": "rDNS updated." }Compute
SSH Keys
Public keys saved to your account, reusable across any VPS you deploy.
/api/sshkey/API keyList your saved SSH keys.
Example response · 200
[ { "id": 5, "title": "laptop", "ssh_key": "ssh-ed25519 AAAA...", "created_at": "2026-05-01" } ]/api/sshkey/API keySave a new public key. Validated as a real SSH public key; duplicate titles on your account are rejected.
Request body
title *stringA name for this key, unique to your account.ssh_key *stringThe public key contents (e.g. id_ed25519.pub).Example response · 201
{ "id": 6, "title": "deploy-key", "ssh_key": "ssh-ed25519 AAAA...", "created_at": "2026-08-17" }/api/sshkey/{id}/API keyRemove a saved key.
Example response · 204
{}Compute
Firewall Rules
Per-VPS firewall rules, nested under the VPS resource.
/api/vps/{vps_id}/firewall_rules/API keyList the custom rules on one VPS. The rule set's current version comes back in the X-Rules-Version header; add ?with_version=true to get it in the body instead, as below. Keep it for the update.
Example response · 200
{ "results": [ { "id": 2, "direction": "in", "ip_type": "ipv4", "decision": "accept", "protocol": "tcp", "src_port": "any", "dest_port": "22", "source": "0.0.0.0/0" } ], "rules_version": "9f2c41e0" }/api/vps/{vps_id}/firewall_rules/updateRules/API keyReplace the full rule set for this VPS in one call — rules present in the array are kept/created, anything missing from it is deleted (a diff, not an append). The body is the array itself, not an object wrapping it. Pass the rules_version you got from the GET: if someone changed the rules since you read them, you get a 409 instead of silently overwriting their change, so read again and retry.
Request body
(array body) *arrayEach item: { direction, ip_type, decision, protocol, src_port, dest_port, source }.Query params
rules_versionstringThe rules_version from your last GET. Optional, but without it a concurrent change is overwritten.Example response · 200
{ "message": "Firewall rules updated." }Networking
IP Addresses
Standalone IPv4 addresses — purchased independently of any VM, attached or detached whenever you need to.
/api/ip-addresses/API keyList every IP you own.
Query params
popintFilter to one region.unattachedbooltrue/false — filter to addresses with (or without) a VPS attached.Example response · 200
[ { "id": 91, "ip": "198.51.100.7", "vps": null, "status": "active", "purchased_at": "2026-06-01T00:00:00Z" } ]/api/ip-addresses/available/API keyAvailability and price for purchasing new addresses in a region — the picker source before calling purchase.
Query params
pop *intRegion id.Example response · 200
{ "pop": 2, "pop_city": "Frankfurt", "monthly_price": 1.6, "available_count": 42, "remaining_quota": 8 }/api/ip-addresses/purchase/API keyBuy one or more addresses in a region. Synchronous — addresses are reserved and returned in the same response. Max 20 per call. Accepts an Idempotency-Key header so a retry doesn't buy twice.
Request body
pop *intRegion id.quantity *int1–20.Example response · 201
[ { "id": 104, "ip": "198.51.100.88", "status": "active" } ]/api/ip-addresses/{id}/attachable_vps/API keyYour VMs in the same region as this IP, eligible to attach it to.
Example response · 200
[ { "id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "hostname": "web-01", "is_stopped": false } ]/api/ip-addresses/{id}/attach/API keyAttach this address to one of your VMs (same region only). Synchronous.
Request body
vps *uuidTarget VPS id.Example response · 200
{ "id": 91, "ip": "198.51.100.7", "vps": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90" }/api/ip-addresses/{id}/detach/API keyDetach this address from whatever VM it's attached to. Synchronous.
Example response · 200
{ "id": 91, "ip": "198.51.100.7", "vps": null }/api/ip-addresses/{id}/API keyRelease an address for good — must be detached first.
Example response · 204
{ "message": "IP address released." }Storage
Volumes
Standalone block storage — including boot volumes. Create one, install an OS on it, set it as a VM's boot disk, or move it to a different VM entirely.
Every mutating volume action below is asynchronous — it returns 202 with a task_id immediately, not the finished result. Poll task-status until status is "completed" (or "failed").
/api/volumes/API keyList every volume you own.
Query params
popintFilter to one region.unattachedboolFilter to volumes with (or without) a VPS attached.Example response · 200
[ { "id": 55, "name": "vol-a83f", "size": 160, "kind": "data", "vps": null, "os_name": null } ]/api/volumes/available/API keyPrice and eligibility for purchasing in a region — including whether this region requires naming an existing VPS at purchase time (non-fleet regions).
Query params
pop *intRegion id.Example response · 200
{ "pop": 2, "monthly_price_per_gb": 0.0144, "allowed_sizes_gb": [20, 40, 80, 160, 320, 520], "is_fleet_backed": true, "eligible_vps": [] }/api/volumes/purchase/API keyCreate a new volume — a data disk, or a boot volume with nothing installed on it yet. Accepts an Idempotency-Key header so a retry doesn't create a second volume.
Request body
pop *intRegion id.size_gb *intOne of the allowed sizes for this region.kindstring"data" (default) or "boot".vps_iduuidRequired for a data disk in a non-fleet region — pins the volume to that VM's own node.Example response · 202
{ "task_id": 881, "status": "pending" }/api/volumes/task-status/{task_id}/API keyPoll the result of purchase/attach/detach/destroy/install_os/resize/set_as_boot.
Example response · 200
{ "task_id": 881, "type": "volume_create", "status": "completed", "volume": { "id": 55, "size": 160 } }/api/volumes/{id}/attachable_vps/API keyYour VMs in the same region as this volume, annotated with whether each already has a boot volume.
Example response · 200
[ { "id": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "hostname": "web-01", "is_stopped": true, "has_boot_volume": false } ]/api/volumes/{id}/available_os/API keyOS templates installable on this volume (fleet-backed volumes only). Always a plain list, empty if nothing's installable right now.
Example response · 200
[ { "id": 3, "name": "Ubuntu 24.04", "distro": "ubuntu" } ]/api/volumes/{id}/install_os/API keyInstall an OS onto this volume, overwriting whatever was on it. Must be detached first. Windows requires a password; others need an SSH key, a password, or both — so an API key needs the full scope.
Request body
operating_system *intOS id from available_os.ssh_public_keystringPublic key to install (non-Windows).root_passwordstringRoot/administrator password.Example response · 202
{ "task_id": 882, "status": "pending" }/api/volumes/{id}/resize/API keyGrow a volume live — works whether it's attached or not. Grow-only, next size up from the allowed tiers.
Request body
size_gb *intMust be larger than the current size.Example response · 202
{ "task_id": 883, "status": "pending" }/api/volumes/{id}/attach/API keyAttach this volume to a VM as a plain (non-boot) data disk. Same region only.
Request body
vps *uuidTarget VPS id.Example response · 202
{ "task_id": 884, "status": "pending" }/api/volumes/{id}/set_as_boot/API keySet this volume as a VM's boot disk — swaps out whatever boot volume it currently has, if any. Fleet-backed volumes only; the target VM must be stopped.
Request body
vps *uuidTarget VPS id.Example response · 202
{ "task_id": 885, "status": "pending" }/api/volumes/{id}/detach/API keyDetach this volume from whatever VM it's on — including a boot volume.
Example response · 202
{ "task_id": 886, "status": "pending" }/api/volumes/{id}/API keyRelease a volume for good — must be detached first.
Example response · 202
{ "task_id": 887, "status": "pending" }Reference data
Regions & Operating Systems
Read-only catalogs — the region and OS ids every create/deploy request above needs, plus any maintenance affecting your own infrastructure.
/api/pop/API keyList every region, with per-resource hourly pricing (vCPU/RAM/disk/traffic hourly, IP monthly).
Example response · 200
[ { "id": 2, "city": "Frankfurt", "country": "Germany", "cpu_price": 0.004, "ram_price": 0.00035, "disk_price": 0.00002, "ip_price": 1.6 } ]/api/os/API keyList every installable operating system template.
Example response · 200
[ { "id": 3, "name": "Ubuntu 24.04", "distro": "ubuntu", "virt_type": "kvm" } ]/api/maintenance-events/paginatedAPI keyPublished maintenance events relevant to you — sitewide notices, or ones touching a region/VM you own. Recently-ended events stay visible for 24h.
Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [ { "id": 12, "title": "Frankfurt network maintenance", "event_type": "network", "status": "scheduled", "start_time": "2026-08-20T02:00:00Z", "end_time": "2026-08-20T04:00:00Z", "scope": "pop", "affected_pops": [ { "id": 2, "city": "Frankfurt", "country": "Germany" } ], "affected_vps": [], "is_published": true } ]
}Account
Account, Billing & Activity
Your plan tier and quota, profile, invoices, transactions, usage cost breakdown, and account activity log.
/api/account/quota/API keyYour plan tier, per-resource limits, current usage, balance, and what the next tier unlocks. See the full tier ladder →
Example response · 200
{
"current_tier": "starter", "is_custom": false,
"limits": { "max_cores": 32, "max_ram_gb": 64, "max_disk_gb": 1040, "max_ips": 8 },
"usage": { "cores": 4, "ram_gb": 8, "disk_gb": 160, "ips": 1 },
"next_tier": "growth", "balance": 42.18,
"currency": "USD", "currency_symbol": "$"
}/api/users/me/API keyYour account profile and balance.
Example response · 200
{
"id": 88, "email": "[email protected]", "name": "Jane Doe",
"balance": 42.18, "currency": { "short_name": "USD", "symbol": "$" },
"country": "Germany", "company_name": null, "is_verified": true,
"kyc_verified": false, "is_2fa": false
}/api/users/me/API keyUpdate your profile. A read-only key can GET this but not PATCH it.
Request body
namestringDisplay name.addressstringBilling address.phone_numberstringcountrystringcitystringzip_codestringcompany_namestringtax_idstringExample response · 200
{ "id": 88, "name": "Jane Doe", "...": "..." }/api/invoices/paginatedAPI keyList your invoices, paginated 5 per page.
Query params
searchstringSearch by id, status, amount, or line-item name/hostname.orderingstringe.g. -created_at, total_amount.Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [
{ "id": 501, "created_at": "2026-08-01", "due_date": "2026-08-08",
"status": "paid", "total_amount": "17.86",
"currency": { "symbol": "$", "short_name": "USD" },
"items": [ { "id": 1, "name": "web-01 compute", "hours": 720, "price": "17.86", "resource_type": "compute" } ] }
]
}/api/transactions/paginatedAPI keyList your balance transactions (top-ups, invoice payments, refunds), paginated 5 per page. balance_before/balance_after are staff-only, not shown to a customer's own key.
Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [
{ "id": "b6e2...", "transaction_type": "topup", "currency": { "short_name": "USD" },
"amount": "50.00", "source": "razorpay", "status": "completed", "created_at": "2026-08-01T10:00:00Z" }
]
}/api/usage-billing/overview/API keyLive unbilled usage (compute/storage/network/bandwidth/backups) plus already-billed cost by month and category over a date range.
Query params
start / enddateYYYY-MM-DD, both optional, both required if either is given. Bounds the billed section only — unbilled is always "as of now." Defaults to the trailing 6 months.Example response · 200
{
"currency": { "symbol": "$", "short_name": "USD" },
"unbilled": { "summary": { "compute": 4.2, "storage": 0.6, "network": 0.1, "bandwidth": 0, "backups": 0, "total": 4.9 }, "usage_rows": [], "backup_rows": [], "bandwidth_rows": [], "error_rows": [] },
"billed": { "start": "2026-03-01", "end": "2026-08-17", "by_category": { "compute": 82.1, "storage": 6.4, "network": 3.2, "other": 0, "total": 91.7 }, "by_month": [], "invoice_count": 5 }
}/api/usage-billing/line-items/API keyRow-by-row usage line items backing the overview above, in either direction.
Query params
statusstring"unbilled" (default) or "billed".start / enddateYYYY-MM-DD — billed only, both required if either given. Defaults to the trailing 6 months.categorystring"all" (default), "compute", "storage", or "network".searchstringHostname substring.page / page_sizeintpage_size default 10, capped at 100 — a different pagination shape than the DRF-paginated endpoints elsewhere on this page.Example response · 200
{
"count": 1, "page": 1, "page_size": 10, "num_pages": 1,
"results": [ { "id": "usage-9001", "type": "Compute", "category": "compute", "hostname": "web-01", "cost": 4.2, "date": "2026-08-17", "billed": false } ]
}/api/activity/paginatedAPI keyYour account activity log, paginated 5 per page.
Query params
searchstringSearch action/description/ip_address/user_agent.Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [ { "id": 9001, "action": "vps.create", "description": "Created VPS web-01", "vps": "3f9c2a7e-5b1d-4c8e-9a6f-2d4b8e1c7a90", "ip_address": "198.51.100.10", "timestamp": "2026-08-17T09:00:00Z" } ]
}/api/api_keys/Dashboard onlyList or create your API keys. Dashboard session only — a key can't be used to manage keys. The full key (iota_…) is in the create response only; listing keys never shows it again. Each key also has an expiry you pick when creating it: send expires_in_days as 30, 90 (default) or 365, or null for never; the key's expires_at says when.
Request body
name *stringA label for this key.scopestring"read_only" (default), "read_write", or "full" (read, write & run commands).allowed_ipstringOptional — lock this key to one source IP.Example response · 200
{ "id": 4, "name": "ci-deploy", "key": "iota_7Hq2...xV9c", "scope": "read_only", "is_active": true, "allowed_ip": null, "created_at": "2026-08-17T09:00:00Z" }/api/api_keys/{id}/Dashboard onlyUpdate (e.g. deactivate, widen scope, set allowed_ip) or permanently delete a key. Dashboard session only.
Example response · 200
{ "id": 4, "is_active": false }Support
Support Tickets
Open and reply to support tickets — the same conversation the dashboard shows, reachable from your own code too.
/api/departments/API keyList support departments, to pick one when opening a ticket.
Example response · 200
[ { "id": 1, "name": "Billing" }, { "id": 2, "name": "Technical" } ]/api/tickets/paginatedAPI keyList your tickets, paginated 5 per page.
Example response · 200
{
"count": 1, "next": null, "previous": null,
"results": [ { "id": 77, "subject": "VM unreachable", "priority": "high", "department": { "id": 2, "name": "Technical" }, "vps": null, "status": "open", "assigned_to": null, "created_at": "2 hours ago" } ]
}/api/tickets/API keyOpen a new ticket.
Request body
subject *stringdepartment_id *intFrom GET /api/departments/.messagestringOpening message.prioritystringe.g. "low" / "medium" / "high".vps_iduuidOptional — associate this ticket with one of your VMs.Example response · 201
{ "id": 78, "subject": "VM unreachable", "status": "open", "...": "..." }/api/tickets/{id}/API keyRetrieve one ticket, including its full reply thread embedded (unpaginated).
Example response · 200
{ "id": 77, "subject": "VM unreachable", "replies": [ { "id": 1, "message": "...", "replied_by": "...", "created_at": "2 hours ago" } ] }/api/tickets/{ticket_id}/replies/paginatedAPI keyThe reply thread, paginated — the same data as the ticket detail's embedded replies field, in pages.
Example response · 200
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 1, "message": "We're looking into it.", "replied_by": "...", "created_at": "1 hour ago", "images": [] } ] }/api/tickets/{ticket_id}/replies/API keyPost a reply on a ticket you have access to.
Request body
message *stringuploaded_imagesfile[]Up to 5 images, 5 MB each — send as multipart/form-data, not JSON, when attaching any.Example response · 201
{ "id": 2, "message": "Thanks, still seeing it.", "created_at": "just now" }Errors
Errors & status codes
Most errors return a plain {"message": "..."} body. Some validation errors on POST/PATCH return Django REST Framework's per-field format instead, {"field_name": ["error"]}, so it's worth handling both.
Most list endpoints aren't paginated. A GET to a list route returns a plain array of everything you own. A few (marked paginated below: VPS, Invoices, Transactions, Activity Log, Tickets) return DRF's wrapped {"count", "next", "previous", "results"} format instead, with page_size=5 by default. Pass ?page_size= (up to 100000) to get everything in one call.
Not in the API
Dashboard-only endpoints
These are part of the same API, but for now they only accept a logged-in dashboard session and won't work with an API key. We list them here so your scripts don't run into an unexpected 401.
Get started
Generate your first API key
₹800 signup bonus after KYC ($10 for international accounts). Create a key from the dashboard and start scripting in minutes.