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 پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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

POST /v1/fleet/register