fleet

POST `/v1/fleet/heartbeat`

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`instance_id`	`string`	Igen	—
`agent_version`	`string`	Nem	—
`report`	`WorkerHostReport`	Nem	One heartbeat's observed host state.

Válasz

Név	Típus	Kötelező	Mi ez
`worker_id`	`string`	Nem	—
`hostname`	`string`	Nem	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Nem	—
`accepts_deploys`	`boolean`	Nem	—
`region`	`string`	Nem	—
`pool`	`string`	Nem	—
`driver`	`string`	Nem	—
`capacity`	`integer`	Nem	—
`product_lines`	`string[]`	Nem	—
`heartbeat_interval_seconds`	`integer`	Nem	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`	Nem	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[]`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 422 · 429

POST /v1/fleet/heartbeat