URL parameters

Currently supported actions are:

• remove: Removes the node from the cluster after migrating all bound resources to other nodes. As soon as a successful remove request is received, the cluster will no longer automatically migrate resources, such as shards and endpoints, to the node even if the remove task fails at some point.

  • By default, the remove node action completes after all resources migrate off the removed node. Node removal does not wait for migrated shards' persistence files to be created on the new nodes.

    To change node removal to wait for the creation of new persistence files for all migrated shards, set wait_for_persistence to true in the request body or update the cluster policy persistent_node_removal to true to change the cluster's default behavior.

    POST /v1/nodes/<node_id>/actions/remove
    {
        "wait_for_persistence": true
    }
    

• maintenance_on: Creates a snapshot of the node, migrates shards to other nodes, and prepares the node for maintenance. See maintenance mode for more information.

  • As of Redis Enterprise Software version 7.4.2, a new node snapshot is created only if no maintenance mode snapshots already exist or if you set "overwrite_snapshot": true in the request body.

    POST /v1/nodes/1/actions/maintenance_on
    {
        "overwrite_snapshot": true
    }
    

  • If there aren't enough resources to migrate shards out of the maintained node, set "evict_ha_replica": false and "evict_active_active_replica": false in the request body to keep the replica shards in place but demote any master shards. Use these two parameters instead of keep_slave_shards, which is deprecated as of Redis Enterprise Software version 7.4.2.

    POST /v1/nodes/1/actions/maintenance_on
    {
        "overwrite_snapshot": true,
        "evict_ha_replica": false,
        "evict_active_active_replica": false
    }
    

  • To specify databases whose shards should be evicted from the node when entering maintenance mode, set "evict_dbs": ["List of database ID strings"] in the request body.

    POST /v1/nodes/1/actions/maintenance_on
    {
        "overwrite_snapshot": true,
        "evict_dbs": ["1", "3"] 
    }
    

• maintenance_off: Restores node to its previous state before maintenance started. See maintenance mode for more information.

  • By default, it uses the latest node snapshot.

  • Use "snapshot_name": "..." in the request body to restore the state from a specific snapshot.

  • To avoid restoring shards at the node, use "skip_shards_restore": true.

• enslave_node: Turn node into a replica.

$ curl -k -X POST -u "[username]:[password]" -d "{}"
            https://[host][:port]/v1/nodes/1/actions/remove

import requests
import json

url = "https://[host][port]/v1/nodes/1/actions/remove"

payload = json.dumps({})
headers = {
  'Content-Type': 'application/json',
}
auth = ("[username]", "[password]")

response = requests.request("POST", url, auth=auth, headers=headers, data=payload)

print(response.text)

DELETE /v1/nodes/{node_uid}/actions/{action}

DELETE /v1/nodes/1/actions/remove