fleet

POST `/v1/fleet/drain`

Take this host out of placement on graceful shutdown.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`instance_id`	`string`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`worker_id`	`string`	Não	—
`hostname`	`string`	Não	—
`status`	`string<provisioning, active, draining, down, decommissioned>`	Não	—
`accepts_deploys`	`boolean`	Não	—
`region`	`string`	Não	—
`pool`	`string`	Não	—
`driver`	`string`	Não	—
`capacity`	`integer`	Não	—
`product_lines`	`string[]`	Não	—
`heartbeat_interval_seconds`	`integer`	Não	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…

Erros que este endpoint pode retornar

401 · 422 · 429

POST /v1/fleet/drain