fleet

POST `/v1/fleet/heartbeat`

Stamp fleet liveness, ship the host report, collect queued commands.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

curl -X POST https://api.zinndigital.com/v1/fleet/heartbeat \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "instance_id": <string> }'

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

Sent every `heartbeatIntervalSeconds`. Carries the host health report — the same document the console has always shown — because the heartbeat and the report answer the same question, and one call means the report can never be fresher than the heartbeat it is judged against. **This is where a declared box becomes real capacity.** A host that has never heartbeated is promoted to `active` **and** starts accepting deploys on its first successful beat; every beat after that leaves `acceptsDeploys` untouched, so an operator's drain sticks across an agent restart. A `down` host that heartbeats again is revived to `active` or `draining` according to the operator's existing intent. A `decommissioned` host gets `continue: false` and nothing is written. The response carries any commands the engine claimed for this host (bounded per tick). The claim is still `SELECT … FOR UPDATE SKIP LOCKED`, so exactly-once semantics are unchanged; only *who runs the query* moved, because a worker box has no database connection.

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`instance_id`	`string`	Da	—
`agent_version`	`string`	Nu	—
`report`	`WorkerHostReport`	Nu	One heartbeat's observed host state.

Răspuns

Nume	Tip	Obligatoriu	Ce este
`worker_id`	`string`	Nu	—
`hostname`	`string`	Nu	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Nu	—
`accepts_deploys`	`boolean`	Nu	—
`region`	`string`	Nu	—
`pool`	`string`	Nu	—
`driver`	`string`	Nu	—
`capacity`	`integer`	Nu	—
`product_lines`	`string[]`	Nu	—
`heartbeat_interval_seconds`	`integer`	Nu	How often to heartbeat, decided engine-side. The box no longer reads its own interval from an env file, so "the host-down window is ten missed beats" stays a fact about the depl…
`continue_running`	`boolean`	Nu	False only for an answered "this host is gone" (decommissioned or removed). An error is never reported as one — that distinction is what stops a transient failure retiring a…
`commands`	`WorkerClaimedCommand[]`	Nu	—

Erori pe care le poate returna acest punct final

401 · 422 · 429

POST /v1/fleet/heartbeat