Admiral
Runner

Unlock state for a job

POST
/api/v1/runner/jobs/{job_id}/state/unlock

The server validates that the SAT's runner binding matches the runner assigned to this job. Returns PERMISSION_DENIED if they do not match. Returns FAILED_PRECONDITION if the lock_id does not match the currently held lock. Returns NOT_FOUND if no lock is held.

Maps to Terraform HTTP backend POST on the unlock address.

Scope: state:write | Token types: sat

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

job_id*job_id

The job releasing the lock (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/runner/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/state/unlock" \  -H "Content-Type: application/json" \  -d '{}'
{}