SIsignal18
DatabaseMaintenance

Set a server to maintenance mode

Changed on

Sets a specified server within a cluster to maintenance mode. Maintenance mode is durable: it is written to the cluster's dynamic configuration and restored on process restart or config reload, so the server stays excluded from proxy routing and failover election until maintenance is explicitly cleared. Requires monitoring-save-config=true (the default) to survive a restart.

get/api/clusters/{clusterName}/servers/{serverName}/actions/set-maintenance

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: Authorization

Path parameters

clusterNamestring required

Cluster Name

serverNamestring required

Server Name

Headers

Authorizationstring required

Insert your access token

Response

Server set to maintenance mode successfully

string required

Changes