Skip to main content

POST /api/agent/{zid}/plans/lock

Promotes the current draft (or the body shape) to a new locked version.

Bumps version = max(prior locked) + 1, marks prior locked rows superseded, patches agent_protocol_state.current_plan_id. Emits a plan_locked audit r

MethodPOST
Path/api/agent/{zid}/plans/lock
Feature areaAgent
TagAccounts & Keys
Authmachine key — Authorization: Bearer $ZEQ_KEY
Tierauthenticated (machine-control)

Parameters

Path parameters

NameTypeRequiredDescription
zidstringyes

No query or header parameters are published for this operation.

Request body

Optional. Content type: application/json.

The node publishes this body as a free-form JSON object — no field schema is exposed in openapi.json. Send the fields the summary above describes; the endpoint validates them and refuses rather than guessing.

Responses

StatusMeaning
200OK
400Bad request — a parameter or body field is missing or malformed
401Missing or invalid credentials
500Server error

400 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

401 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

500 body

FieldTypeRequiredDescription
okboolean — one of falseyes
errorstringnoHuman-readable message.
codestringnoStable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED.

Call it

curl -sS -X POST https://zeq.me/api/agent/ZEQ7B3K9QX2M7T4V8N1C6H0DZ/plans/lock \
-H "Authorization: Bearer $ZEQ_KEY" \
-H "Content-Type: application/json" \
-d '{}'

Needs a machine key. Mint one: curl -sS -X POST https://zeq.me/api/demo-key/mint, then spin up your machine.


Generated from the live OpenAPI description (https://zeq.me/openapi.json, spec version 1.287.0) by scripts/generate-reference.mjs. Do not edit — this file is rewritten on every run.