GET /api/agent/{zid}/state
The node publishes no summary for this operation.
| Method | GET |
| Path | /api/agent/{zid}/state |
| Feature area | Agent |
| Tag | Accounts & Keys |
| Auth | machine key — Authorization: Bearer $ZEQ_KEY |
| Tier | authenticated (machine-control) |
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
zid | string | yes | — |
No query or header parameters are published for this operation.
Request body
This operation takes no request body.
Responses
| Status | Meaning |
|---|---|
200 | OK |
400 | Bad request — a parameter or body field is missing or malformed |
401 | Missing or invalid credentials |
403 | Forbidden — authenticated, but not permitted for this resource |
500 | Server error |
400 body
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean — one of false | yes | — |
error | string | no | Human-readable message. |
code | string | no | Stable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED. |
401 body
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean — one of false | yes | — |
error | string | no | Human-readable message. |
code | string | no | Stable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED. |
403 body
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean — one of false | yes | — |
error | string | no | Human-readable message. |
code | string | no | Stable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED. |
500 body
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean — one of false | yes | — |
error | string | no | Human-readable message. |
code | string | no | Stable machine-readable code, e.g. ADMIN_REQUIRED, INVALID_ZID, ZID_NOT_LINKED. |
Call it
curl -sS -X GET https://zeq.me/api/agent/ZEQ7B3K9QX2M7T4V8N1C6H0DZ/state \
-H "Authorization: Bearer $ZEQ_KEY"
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.