Skip to main content
GET
Get machine-visible stop state
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/health/stops reports deployment-wide controls visible to machines. It requires the platform:read permission, and the credential’s scopes must reach it.
The response contains platform_kill and global_spend_freeze, in that order. Each item has an open control string, an engaged boolean, and changedAt. The platform kill switch reports its stored engagement or disengagement time, or null when unavailable. Global spend freeze always reports changedAt: null: its transition time is unavailable because budget write timestamps also change during spending and period resets. Use engaged to determine whether the control is active. The response never includes operator reasons or identities, budget amounts or IDs, agent-specific freezes, or enforcement posture. Stopping, freezing, and resuming Forge are person-only Console actions. A budget-reader failure fails the request rather than reporting that spending is available.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

Current machine-visible stop state

data
object
required

Whether Forge is stopped or global spend is frozen.

meta
object
required