fleet

POST `/v1/fleet/register`

Attach a booting agent to its declared fleet host.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`instance_id`	`string`	Oo	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`	Hindi	—
`python_version`	`string`	Hindi	—
`platform`	`string`	Hindi	—
`boot_id`	`string`	Hindi	`/proc/sys/kernel/random/boot_id`. Distinguishes "the agent restarted" from "the box rebooted" — a crash loop from a kernel panic.
`observed_address`	`string`	Hindi	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…

Tugon

Pangalan	Uri	Kailangan	Ano ito
`worker_id`	`string`	Hindi	—
`hostname`	`string`	Hindi	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Hindi	—
`accepts_deploys`	`boolean`	Hindi	—
`region`	`string`	Hindi	—
`pool`	`string`	Hindi	—
`driver`	`string`	Hindi	—
`capacity`	`integer`	Hindi	—
`product_lines`	`string[]`	Hindi	—
`heartbeat_interval_seconds`	`integer`	Hindi	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…

Mga error na maibabalik ng endpoint na ito

401 · 422 · 429

POST /v1/fleet/register