Skip to content
Fwozen

Docs

REST API overview

Scoped tokens, the freeze endpoints, idempotency keys, and where to find the OpenAPI document for the whole surface.

The REST API is in the free tier, rate-limited, with scoped tokens and a published OpenAPI document. Everything the dashboard does, the API does.

  • POST /v1/freezes — freeze an org, a glob, a set of repos, or one branch. Accepts an Idempotency-Key header so a retry cannot double-freeze.
  • POST /v1/freezes/{id}/lift — thaw.
  • GET /v1/freeze-state — the endpoint your pipeline polls.
  • GET /v1/audit — every action, with actor and source.

Tokens are created in the dashboard with explicit scopes and an expiry, and are shown once. This page is expanding at launch with the full endpoint reference; the OpenAPI document is the authority in the meantime.

Last updated 29 July 2026