Drain the server — REST API

Request the server to enter drain mode

POST /v1/admin:drain: Initiates drain mode and optionally waits for the server to quiesce.

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

Authorization

x-api-key<token>

In: header

timeoutSec?integer | null

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

Default900

Formatint32

reason?string | null

Human-readable reason for initiating drain mode.

waitForQuiesce?boolean | null

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

curl -X POST "https://your-goodmem-server.example.com/v1/admin:drain" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://your-goodmem-server.example.com/v1/admin:drain" \  -H "Content-Type: application/json" \  -d '{}'

{
  "state": "STARTING",
  "quiesced": true,
  "message": "string"
}

Empty