REST API

The REST API is also what the Edge CLI uses under the hood.

Base URL#

https://edge.network/api

All requests use HTTPS. Request and response bodies are JSON. Send Content-Type: application/json on POST, PUT and PATCH requests.

Authentication#

Authenticate with an API key passed as a Bearer token. Keys are created in the console and start with ek_live_.

curl https://edge.network/api/compute/vms \
  -H "Authorization: Bearer ek_live_..."

See Authentication for creating and managing keys.

Quick start: create a VM#

curl -X POST https://edge.network/api/compute/vms \
  -H "Authorization: Bearer ek_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-01",
    "osTemplate": "ubuntu-24.04",
    "vcpu": 2,
    "ram": 4,
    "disk": 80,
    "region": "london"
  }'

The response includes the new VM object and, if no SSH key was attached, a generated root password. Full request and response details are on the Compute API page.

API reference#

Errors#

Errors return an appropriate HTTP status code and a JSON body with a message and a stable machine-readable code:

{
  "error": "VM not found",
  "code": "NOT_FOUND"
}

See Errors for the full list of codes and rate-limit behaviour.

Rate limits#

Requests are rate limited to 600 requests per minute per IP across the API. Every response includes X-RateLimit-Limit and X-RateLimit-Remaining headers; exceeding the limit returns 429 with a Retry-After header.

Other ways to integrate#

• Edge CLI: A command-line client for this API. Ideal for scripts and CI pipelines.
• Agent API: A self-describing API for AI agents, with scoped tokens, budgets and dry-run support.