Skip to main content
JUMP TO:Quick StartCLI CommandsConfigurationPlaywright APIMCP ServerGitHub Actions
Guides / Cloud API(18 of 37)

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.

Zero-Pollution Git Orphan and Cloud CAS Storage
FIG 01 · BASELINE STORAGE ARCHITECTURE — STAGE 1 GIT ORPHAN BRANCH (frontguard-baselines) & STAGE 3 CLOUD R2 CAS (/v1/cas)

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

environment
FRONTGUARD_API_URL=https://your-frontguard-api.example.com
FRONTGUARD_API_KEY=fg_live_your_token_here

API endpoints overview

The OpenAPI 3.1 specification is published at /openapi.json and synchronized with packages/cloud-api/src/openapi.json:

Method & PathAuthPurpose
GET /healthPublicReturns service health and D1 SQLite database connectivity status.
POST /v1/runBearer API KeySubmits a visual regression run for asynchronous processing.
GET /v1/runsBearer API KeyLists recent runs visible to the authenticated caller.
GET /v1/runs/{id}Bearer API KeyRetrieves a specific run and its per-route comparison results.
DELETE /v1/runs/{id}Bearer API KeyDeletes a run and performs best-effort cleanup of its screenshot blobs.
GET /v1/reports/{id}Bearer API KeyFetches the completed HTML report for a run.
POST /v1/baselines/{runId}/approveBearer API KeyRecords whole-run baseline approval metadata in D1 (does not promote git screenshots).
GET /v1/usageBearer API KeyReturns current monthly run and screenshot usage counters.
POST /v1/cas/checkBearer API KeyChecks a batch of SHA-256 digests against R2 and returns existing vs missing hashes.
PUT /v1/cas/blobs/{sha256}Bearer API KeyVerifies the SHA-256 digest of a PNG payload and stores it immutably in R2.
GET /v1/cas/blobs/{sha256}Bearer API KeyStreams 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.