fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`instance_id`	`string`	Da	—

Răspuns

Nume	Tip	Obligatoriu	Ce este
`worker_id`	`string`	Nu	—
`hostname`	`string`	Nu	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Nu	—
`accepts_deploys`	`boolean`	Nu	—
`region`	`string`	Nu	—
`pool`	`string`	Nu	—
`driver`	`string`	Nu	—
`capacity`	`integer`	Nu	—
`product_lines`	`string[]`	Nu	—
`heartbeat_interval_seconds`	`integer`	Nu	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…

Erori pe care le poate returna acest punct final

401 · 422 · 429

POST /v1/fleet/drain