REST API

Drive every dashboard action over HTTP with a bearer API key.

Every dashboard action is also a REST endpoint under https://gheima.ma/api/v1. Authenticate with a bearer token; keys are rate-limited to 120 requests per minute (see the X-RateLimit-* response headers). The full machine-readable spec is at /api/v1/openapi.json.

Shell

# List services (cursor-paginated: ?limit=&cursor=&type=WEB|WORKER|STATIC)
curl "https://gheima.ma/api/v1/services?limit=20" \
  -H "Authorization: Bearer gh_xxxxx"

# Create a service
curl -X POST https://gheima.ma/api/v1/services \
  -H "Authorization: Bearer gh_xxxxx" -H "content-type: application/json" \
  -d '{"projectId":"prj_1","name":"web","repoUrl":"https://github.com/me/app"}'

# Trigger a deployment -> 202 { deploymentId }
curl -X POST https://gheima.ma/api/v1/services/<id>/deploy \
  -H "Authorization: Bearer gh_xxxxx"

List endpoints are cursor-paginated: pass ?limit= (1–100) and ?cursor=, and read the next cursor from the response’s pagination.nextCursor.

✦ Any language that can make an HTTP request can drive Gheima.