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, за да можете да видите действителния отговор. Отворете този крайpoint в 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 ne… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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 depl… |
Грешки, които този крайpoint може да върне
401 · 422 · 429