fleet

POST `/v1/fleet/heartbeat`

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

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Tělo požadavku

Název	Typ	Požadováno	Co to je
`instance_id`	`string`	Ano	—
`agent_version`	`string`	Ne	—
`report`	`WorkerHostReport`	Ne	One heartbeat's observed host state.

Odpověď

Název	Typ	Požadováno	Co to je
`worker_id`	`string`	Ne	—
`hostname`	`string`	Ne	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Ne	—
`accepts_deploys`	`boolean`	Ne	—
`region`	`string`	Ne	—
`pool`	`string`	Ne	—
`driver`	`string`	Ne	—
`capacity`	`integer`	Ne	—
`product_lines`	`string[]`	Ne	—
`heartbeat_interval_seconds`	`integer`	Ne	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…
`continue_running`	`boolean`	Ne	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[]`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 422 · 429

POST /v1/fleet/heartbeat