fleet

POST `/v1/fleet/register`

Attach a booting agent to its declared fleet host.

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/register \
  -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

Called once when a worker-host agent starts. **Idempotent**, and structurally incapable of creating a fleet row: the host is the credential's foreign-key target, so re-registering converges the same row, and a re-register after the host was deleted cannot resurrect it (the delete cascaded the credential away, so the request no longer authenticates). **Registration does not make the box placeable.** It writes no status, no `acceptsDeploys` and no heartbeat stamp — a box that registers and then dies is still `provisioning` with a null heartbeat, and its declared capacity still counts zero toward placeable capacity. Promotion happens on the first *heartbeat*. The request carries only what a box can honestly observe about itself. There is deliberately no capacity/region/pool/driver/`acceptsDeploys` field: those are operator facts set with `manage.py register_worker_host`, and a box that could declare `capacity=100000, pool=pbn` would pull every new PBN site onto itself.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`instance_id`	`string`	Igen	This process's identity (machine/container name) — not the host's. The host's name is read off the credential and is not accepted from the caller.
`agent_version`	`string`	Nem	—
`python_version`	`string`	Nem	—
`platform`	`string`	Nem	—
`boot_id`	`string`	Nem	`/proc/sys/kernel/random/boot_id`. Distinguishes "the agent restarted" from "the box rebooted" — a crash loop from a kernel panic.
`observed_address`	`string`	Nem	The address this box believes it answers on. Advisory only: recorded on the registration audit row so an operator can compare it with the operator-set origin address, and ne…

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…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 422 · 429

POST /v1/fleet/register