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.
ApiKeyAuthx-api-key<token>GoodMem-Timeout-Ms?integerOptional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.
int641 <= value <= 86400000application/json- body
timeoutSec?|Maximum seconds to wait for the server to quiesce before returning.
int32900reason?|Human-readable reason for initiating drain mode.
waitForQuiesce?|If true, wait for in-flight requests to complete and the server to reach QUIESCED before responding.
Drain request acknowledged
application/json- response
state?stringLifecycle state reported after the drain request was processed.
"STARTING""READY""DRAINING""QUIESCED"quiesced*booleanWhether the server has reached the QUIESCED lifecycle state.
message?stringHuman-readable status message describing the drain outcome.
curl -X POST 'https://your-goodmem-server.example.com/v1/admin:drain' \ -H 'GoodMem-Timeout-Ms: 30000' \ -H 'Content-Type: application/json' \ -d '{}'{ "state": "STARTING", "quiesced": true, "message": "string"}Delete a RetrieveMemory log policy
DELETE /v1/admin/retrieve-memory-log-policies/{id}: Idempotently tombstones an immutable RetrieveMemory log policy.
Get a RetrieveMemory log policy
GET /v1/admin/retrieve-memory-log-policies/{id}: Retrieves a live RetrieveMemory log policy by UUID, or a tombstoned policy when includeDeleted is true.