Admiral
States

Force unlock a state

POST
/api/v1/states/{state_id}/force-unlock

Returns NOT_FOUND if the state record does not exist. Returns FAILED_PRECONDITION if the state has no active lock. This action is logged in the audit trail.

Scope: state:admin

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...

In: header

Path Parameters

state_id*state_id

The state record to force-unlock (UUID).

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://admiral.example.com/api/v1/states/497f6eca-6276-4993-bfeb-53cbbbba6f08/force-unlock" \  -H "Content-Type: application/json" \  -d '{}'
{}