ავტორიზაცია
API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your 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> }'შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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… |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 422 · 429