Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
instance_id | string | Ja | 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 | Nein | — |
python_version | string | Nein | — |
platform | string | Nein | — |
boot_id | string | Nein | `/proc/sys/kernel/random/boot_id`. Distinguishes "the agent restarted" from "the box rebooted" — a crash loop from a kernel panic. |
observed_address | string | Nein | 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… |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
worker_id | string | Nein | — |
hostname | string | Nein | — |
status | string<provisioning, active, draining, down, decommissioned> | Nein | — |
accepts_deploys | boolean | Nein | — |
region | string | Nein | — |
pool | string | Nein | — |
driver | string | Nein | — |
capacity | integer | Nein | — |
product_lines | string[] | Nein | — |
heartbeat_interval_seconds | integer | Nein | 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… |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 422 · 429