fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

The only availability change a box may make for itself, and safe in the direction it moves: a host can take itself **out** of service and never back **in**. Returning requires either the once-only first-heartbeat promotion or a staff undrain (`setWorkerDrain`). Idempotent; a `decommissioned` host is left alone.

درخواست کا باڈی

نام	قسم	لازمی	یہ کیا ہے
`instance_id`	`string`	ہاں	—

جواب

نام	قسم	لازمی	یہ کیا ہے
`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/drain