HTTP API
The control plane exposes a versioned REST API under /api/v1/.
OpenAPI document
Section titled “OpenAPI document”The canonical specification lives in the repository:
Import that file into Postman, Insomnia, or your API client generator.
Authentication
Section titled “Authentication”When TEST_SCALE_API_KEY is configured on the server, clients must send:
X-Test-Scale-Key: <your-api-key>Worker report endpoints accept the worker key where documented in the OpenAPI file.
Common endpoints
Section titled “Common endpoints”| Method | Path | Purpose |
|---|---|---|
GET |
/ping |
Health check |
POST |
/api/v1/plans |
Create test plan |
GET |
/api/v1/plans |
List plans |
POST |
/api/v1/runs |
Start run |
GET |
/api/v1/runs/{id} |
Run status and report |
POST |
/api/v1/runs/{id}/stop |
Stop run |
GET |
/api/v1/runs/{id}/export |
Export run JSON |
Exact request and response schemas are in OpenAPI.
CLI vs API
Section titled “CLI vs API”The CLI is the recommended interface for plans on disk (including ${ENV_VAR} expansion). The API accepts JSON bodies directly; environment expansion is not applied server-side.