Skip to content
POST /registry/undrain

Deletes the client's operator drain. The next heartbeat reports draining from the worker's own flag only. A drain whose deadline already passed has already ended the session; undrain does not revive it.

Authentication

pinboard:operator scope. Same scope rule as Drain a client.

Request body

application/json, at most 1 MiB.

FieldTypeRequiredDescription
clientIdstringYesClient to undrain.

Example

curl -X POST https://pinboard.example.com/registry/undrain \
  -H "Authorization: Bearer $PINBOARD_OPERATOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"clientId": "c1e0b7a94f6d4a1e9b2c3d4e5f60718a"}'

Response

200

FieldTypeDescription
revokedbooleantrue when a drain existed and was removed.
{ "revoked": true }

Errors

StatusBodyWhen
401{"error":"unauthorized"}No accepted credential
403{"error":"forbidden"}No pinboard:operator scope, malformed claim, unknown clientId, or the client is outside the claim
503{"error":"not the serving fleet"}Node not serving
413 / 400body too large / invalid json
400{"error":"expected { clientId }"}Schema failure