Cloud API
CLOUD API URL REQUIRED. There is no working hosted default or supported production self-host quick start. Use cloud-dependent source only with a deployment you operate and have independently verified.
The repository includes the Hono + Cloudflare Workers + D1 + R2 source code under packages/cloud-api for engineering evaluation and contract testing.
Current status
Cloudflare Worker, D1, and R2 source exists for development and contract evaluation. api.frontguard.dev is not a working hosted default.
Required URL
API endpoints overview
The OpenAPI 3.1 specification is published at /openapi.json and synchronized with packages/cloud-api/src/openapi.json:
| Method & Path | Auth | Purpose |
|---|---|---|
GET /health | Public | Returns service health and D1 SQLite database connectivity status. |
POST /v1/run | Bearer API Key | Submits a visual regression run for asynchronous processing. |
GET /v1/runs | Bearer API Key | Lists recent runs visible to the authenticated caller. |
GET /v1/runs/{id} | Bearer API Key | Retrieves a specific run and its per-route comparison results. |
DELETE /v1/runs/{id} | Bearer API Key | Deletes a run and performs best-effort cleanup of its screenshot blobs. |
GET /v1/reports/{id} | Bearer API Key | Fetches the completed HTML report for a run. |
POST /v1/baselines/{runId}/approve | Bearer API Key | Records whole-run baseline approval metadata in D1 (does not promote git screenshots). |
GET /v1/usage | Bearer API Key | Returns current monthly run and screenshot usage counters. |
POST /v1/cas/check | Bearer API Key | Checks a batch of SHA-256 digests against R2 and returns existing vs missing hashes. |
PUT /v1/cas/blobs/{sha256} | Bearer API Key | Verifies the SHA-256 digest of a PNG payload and stores it immutably in R2. |
GET /v1/cas/blobs/{sha256} | Bearer API Key | Streams an immutable PNG blob from R2 with long-lived Cache-Control headers. |
Production warning
Do not use the pre-release cloud for production data until deployment, migrations, retention, recovery, and tenant isolation are independently verified.
