GoodMem
ReferenceAPIREST APIGeneral

Request the server to enter drain mode

Initiates drain mode and optionally waits for the server to quiesce.

POST
/v1/admin:drain
x-api-key<token>

In: header

timeoutSec?integer

Maximum seconds to wait for the server to quiesce before returning.

Formatint32
reason?string

Human-readable reason for initiating drain mode.

waitForQuiesce?boolean

If true, wait for in-flight requests to complete and the server to reach QUIESCED before responding.

Response Body

curl -X POST "http://localhost:8080/v1/admin:drain" \  -H "Content-Type: application/json" \  -d '{}'
{
  "state": "STARTING",
  "quiesced": true,
  "message": "string"
}
Empty
Empty