HTTP interface for cluster maintenance

Enable or disable the supervision maintenance mode

Enable or disable the cluster supervision (Agency) maintenance mode

PUT /_admin/cluster/maintenance

This API allows to temporarily enable the supervision maintenance mode. Please be aware that no automatic failovers of any kind will take place while the maintenance mode is enabled. The cluster supervision reactivates itself automatically at some point after disabling it.

To enable the maintenance mode the request body must contain the string "on" (Please note it must be lowercase as well as include the quotes). This will enable the maintenance mode for 60 minutes, i.e. the supervision maintenance will reactivate itself after 60 minutes.

Since ArangoDB 3.8.3 it is possible to enable the maintenance mode for a different duration than 60 minutes, it is possible to send the desired duration value (in seconds) as a string in the request body. For example, sending "7200" (including the quotes) will enable the maintenance mode for 7200 seconds, i.e. 2 hours.

To disable the maintenance mode the request body must contain the string "off" (Please note it must be lowercase as well as include the quotes).

Responses

HTTP 200: is returned when everything went well.

HTTP 400: if the request contained an invalid body

HTTP 501: if the request was sent to a node other than a Coordinator or single-server

HTTP 504: if the request timed out while enabling the maintenance mode

Query the maintenance status of a DB-Server

Check what the maintenance status of a DB-Server is

GET /_admin/cluster/maintenance/{DB-Server-ID}

Path Parameters

• DB-Server-ID (string, required): The ID of a DB-Server.

Check whether the specified DB-Server is in maintenance mode and until when.

Responses

HTTP 200: The request was successful.

• error (boolean): Whether an error occurred. false in this case.

• code (integer): The status code. 200 in this case.

• result (object): The result object with the status. This attribute is omitted if the DB-Server is in normal mode.

  • Mode (string): The mode of the DB-Server. The value is "maintenance".

  • Until (string): Until what date and time the maintenance mode currently lasts, in the ISO 8601 date/time format.

HTTP 400: if the request contained an invalid body

HTTP 412: if the request was sent to an Agent node

HTTP 504: if the request timed out while enabling the maintenance mode

Enable or disable the DB-Server maintenance mode

Enable or disable the maintenance mode of a DB-Server

PUT /_admin/cluster/maintenance/{DB-Server-ID}

Path Parameters

• DB-Server-ID (string, required): The ID of a DB-Server.

Request Body

• mode (string, required): The mode to put the DB-Server in. Possible values:
  • "maintenance"
  • "normal"
• timeout (integer, optional): After how many seconds the maintenance mode shall automatically end. You can send another request when the DB-Server is already in maintenance mode to extend the timeout.

For rolling upgrades or rolling restarts, DB-Servers can be put into maintenance mode, so that no attempts are made to re-distribute the data in a cluster for such planned events. DB-Servers in maintenance mode are not considered viable failover targets because they are likely restarted soon.

Responses

HTTP 200: The request was successful.

• error (boolean): Whether an error occurred. false in this case.

• code (integer): The status code. 200 in this case.

HTTP 400: if the request contained an invalid body

HTTP 412: if the request was sent to an Agency node

HTTP 504: if the request timed out while enabling the maintenance mode