SIsignal18
DatabaseMaintenance

Toggle maintenance mode on a server

Changed on

Toggles the maintenance mode on a specified server within a cluster. Maintenance mode is durable: it is written to the cluster's dynamic configuration and restored on process restart or config reload, so a 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/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

Maintenance mode toggled successfully

string required

Changes