fleet
POST /v1/fleet/register
Attach a booting agent to its declared fleet host.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
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 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 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