fleet

POST `/v1/fleet/register`

Attach a booting agent to its declared fleet host.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`instance_id`	`string`	Так	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`	Ні	—
`python_version`	`string`	Ні	—
`platform`	`string`	Ні	—
`boot_id`	`string`	Ні	`/proc/sys/kernel/random/boot_id`. Distinguishes "the agent restarted" from "the box rebooted" — a crash loop from a kernel panic.
`observed_address`	`string`	Ні	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…

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`worker_id`	`string`	Ні	—
`hostname`	`string`	Ні	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Ні	—
`accepts_deploys`	`boolean`	Ні	—
`region`	`string`	Ні	—
`pool`	`string`	Ні	—
`driver`	`string`	Ні	—
`capacity`	`integer`	Ні	—
`product_lines`	`string[]`	Ні	—
`heartbeat_interval_seconds`	`integer`	Ні	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…

Помилки, які може повертати ця кінцева точка

401 · 422 · 429

POST /v1/fleet/register