REST API
Every endpoint, relative to https://api.groundbox.dev/v1. Bodies are JSON with snake_case fields. Money is an integer count of micro-dollars in fields ending _micros.
| Method | Path | Scope |
|---|---|---|
POST | /sandboxes | sandboxes:write |
GET | /sandboxes | sandboxes:read |
GET | /sandboxes/{id} | sandboxes:read |
PATCH | /sandboxes/{id} | sandboxes:write |
DELETE | /sandboxes/{id} | sandboxes:write |
POST | /sandboxes/{id}/exec | sandboxes:write |
GET | /sandboxes/{id}/exec/stream | sandboxes:write |
PUT | /sandboxes/{id}/files | sandboxes:write |
GET | /sandboxes/{id}/files | sandboxes:read |
GET | /sandboxes/{id}/files | sandboxes:read |
POST | /sandboxes/{id}/pause | sandboxes:write |
POST | /sandboxes/{id}/resume | sandboxes:write |
POST | /sandboxes/{id}/fork | sandboxes:write |
GET | /sandboxes/{id}/usage | sandboxes:read |
POST | /schedules | schedules:write |
GET | /schedules | schedules:read |
DELETE | /schedules/{id} | schedules:write |
GET | /account | account:read |
POST | /signup | none |
GET | /ci/runs | ci:read |
GET | /ci/jobs/{id}/logs | ci:read |
POST | /ci/wait | ci:read |
POST | /auth/device/start | none |
POST | /auth/device/token | none |
POST | /feedback | none |
Errors come back as {"error": {"code": "...", "message": "..."}} with a matching HTTP status.
Keys and caps
Create a key under API keys in the dashboard. Keys start with gbx_; keys that start with gbx_test_ are test keys. One key works for CI and for sandboxes.
- Scopes. A key does only what its scopes allow:
sandboxes:read,sandboxes:write,schedules:read,schedules:write,ci:read,ci:write,billing:read,account:read. - Spend cap. A key can have a monthly cap in dollars. The key cannot raise its own cap; the account owner can.
- Agent sign-up. An agent can call
POST /signupwith no key. It gets a key and a claim link; the key works once a person opens the link and approves it.
Questions: contact@groundbox.dev. Prices are on the pricing page.