The REST API backs the web console and SSH commands. The endpoint inventory below and the machine-readable OpenAPI 3.1 document are generated from the public router; internal endpoints are excluded.

authentication

Mint a named token with kedge token, then send it as a Bearer token:

curl -s https://kedge.dev/api/account \
  -H "Authorization: Bearer $KEDGE_TOKEN"

Revoke it with the account token operation. Health and OpenAPI are the only unauthenticated operations in this reference.

conventions

• Base URL: https://kedge.dev/api
• JSON request and response bodies, except SSE, NDJSON, logs, and proxies.
• Send Content-Type: application/json for JSON writes.
• Apps resolve by name or ID. Stable members are selected by ordinal beneath their owning app.
• Errors are JSON objects shaped as {"error":"message"} with an appropriate HTTP status.

examples

Deploy a prebuilt image and follow its logs:

curl -sX POST https://kedge.dev/api/apps \
  -H "Authorization: Bearer $KEDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"hello-nginx","image":"nginx:1.29"}'

curl -sN 'https://kedge.dev/api/apps/hello-nginx/logs?follow=true' \
  -H "Authorization: Bearer $KEDGE_TOKEN"

Run one line in a disposable sandbox:

curl -sX POST https://kedge.dev/api/eval \
  -H "Authorization: Bearer $KEDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"runtime":"python3","code":"print(6*7)","network":false}'

Streaming endpoints intentionally have no short server deadline. Clients should set their own connect and idle timeouts and reconnect SSE streams.

endpoints

account

apps

deploys

builds

data

domains

sandboxes

events

system