Quickstart

In the console, open Settings → API keys and create a key with the full scope (a read key can list but can't deploy). The token is shown once — copy it somewhere safe. Full details are in the Authentication guide.

All calls go to the /api/v1 base path, with your key on every request. Export it once so the examples below just work:

export EKIRE_API_KEY="ek_your_key_here"
export EKIRE_API="https://console.ekire.net/api/v1"

Ekire keys are prefixed ek_. The Authorization: Bearer … header is the only auth you need; there are no cookies or sessions.

Start with a read. GET /instances returns your servers as an items array:

curl "$EKIRE_API/instances" \
  -H "Authorization: Bearer $EKIRE_API_KEY"

A trimmed response:

{
  "items": [
    {
      "id": "b3f1c0a2-8e7d-4b21-9a6c-2f5e1d0a7c44",
      "vmid": 1042,
      "name": "web-01",
      "status": "running",
      "vcpus": 1,
      "memoryMb": 1024,
      "diskGb": 10,
      "osTemplate": "ubuntu-22.04",
      "planId": "nano",
      "monthlyCents": 500,
      "ipAddress": "203.0.113.42",
      "tags": [],
      "regionId": "de-fra",
      "regionName": "Frankfurt",
      "createdAt": "2026-07-19T09:14:22.000Z"
    }
  ]
}

Deploy with POST /instances. Every deploy needs a name (letters, numbers, and hyphens) and exactly one of planId (nano, small, medium) or custom ({ vcpus, memoryMb, diskGb }, priced per unit — the API reference has the bounds). Sending both is refused with 400: that quotes two prices with nothing to say which one you meant. On monthly billing (the default) the server's whole first month is charged at deploy, so your wallet needs that month; on hourly billing it needs at least an hour of runway — below that the call returns 400 insufficient_balance:

curl -X POST "$EKIRE_API/instances" \
  -H "Authorization: Bearer $EKIRE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "planId": "nano",
    "name": "api-demo"
  }'

Everything else is optional — pass any of these to customize the deploy:

A Windows image needs one of those two password fields — Windows signs in over RDP and can't take an SSH key, so a Windows deploy without a password is refused with windows_password_required.

A region that's listed but not open yet is refused with region_coming_soon or region_out_of_stock rather than silently placed elsewhere — see Region waitlist. GET /regions marks those with available: false.

A successful deploy returns 201 Created with the new server (it starts in provisioning):

{
  "id": "a91d7e60-1c4b-4d0e-8f2a-6b3c9e2d5f10",
  "vmid": 0,
  "name": "api-demo",
  "status": "provisioning",
  "planId": "nano",
  "vcpus": 1,
  "memoryMb": 1024,
  "diskGb": 10,
  "ipAddress": "203.0.113.57",
  "createdAt": "2026-07-19T10:02:57.000Z"
}

vmid is 0 here — the hypervisor assigns it during provisioning, so read it from a later GET /instances/{id} rather than the create response.

You've now read and written over the API. Every other resource — volumes, DNS, firewalls, backups, SSH keys — follows the same shape. Browse them all in the interactive API reference.