{
  "id": "cluster",
  "title": "Cluster requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/",
  "summary": "Cluster settings requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-cluster) | `/v1/cluster` | Get cluster info |\n| [PUT](#put-cluster) | `/v1/cluster` | Update cluster settings |\n\n## Get cluster info {#get-cluster}\n\n\tGET /v1/cluster\n\nGet cluster info.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_cluster_info]() |\n\n### Request {#get-request} \n\n#### Example HTTP request\n\n\tGET /v1/cluster \n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response} \n\nReturns a [cluster object]().\n\n#### Example JSON body\n\n```json\n{\n   \"name\": \"my-rlec-cluster\",\n   \"alert_settings\": { \"...\" },\n   \"created_time\": \"2015-04-29T09:09:25Z\",\n   \"email_alerts\": false,\n   \"email_from\": \"\",\n   \"rack_aware\": false,\n   \"smtp_host\": \"\",\n   \"smtp_password\": \"\",\n   \"smtp_port\": 25,\n   \"smtp_tls_mode\": \"none\",\n   \"smtp_username\": \"\"\n}\n```\n\n### Status codes {#get-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n\n## Update cluster settings {#put-cluster}\n\n\tPUT /v1/cluster\n\nUpdate cluster settings.\n\nIf called with the `dry_run` URL query string, the function will\nvalidate the [cluster object](), but will not apply the requested\nchanges.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_cluster]() |\n\n### Request {#put-request} \n\n#### Example HTTP request\n\n\tPUT /v1/cluster \n\n#### Example JSON body\n\n```json\n{\n    \"email_alerts\": true,\n    \"alert_settings\": {\n        \"node_failed\": true,\n        \"node_memory\": {\n            \"enabled\": true,\n            \"threshold\": \"80\"\n        }\n    }\n}\n```\n\nThe above request will enable email alerts and alert reporting for node failures and node removals.\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| dry_run | string | Validate but don't apply the new cluster settings |\n\n#### Request body\n\nInclude a [cluster object]() with updated fields in the request body.\n\n### Response {#put-response} \n\n#### Example JSON body\n\n```json\n{\n    \"name\": \"mycluster.mydomain.com\",\n    \"email_alerts\": true,\n    \"alert_settings\": {\n        \"node_failed\": true,\n        \"node_memory\": {\n            \"enabled\": true,\n            \"threshold\": \"80\"\n        }\n    },\n    \"// additional fields...\"\n}\n```\n\n### Error codes {#put-error-codes} \n\nWhen errors are reported, the server may return a JSON object with `error_code` and `message` field that provide additional information. The following are possible `error_code` values:\n\n| Code | Description |\n|------|-------------|\n| bad_nginx_conf | • Designated port is already bound.\u003cbr\u003e\u003c/br\u003e• nginx configuration is illegal. | \n| bad_debuginfo_path | • Debuginfo path doesn't exist.\u003cbr\u003e\u003c/br\u003e• Debuginfo path is inaccessible. | \n| config_edit_conflict | Cluster config was edited by another source simultaneously. | \n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error. |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad content provided. |\n\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": [{"id":"actions","summary":"Cluster action requests","title":"Cluster actions requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/actions/"},{"id":"alerts","summary":"Cluster alert requests","title":"Cluster alerts requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/alerts/"},{"id":"auditing-db-conns","summary":"Auditing database connections requests","title":"Auditing database connections requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/auditing-db-conns/"},{"id":"certificates","summary":"Cluster certificates requests","title":"Cluster certificates requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/certificates/"},{"id":"change_password_hashing_algorithm","summary":"REST API requests to change the hashing algorithm for user passwords.","title":"Change password hashing algorithm requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/change_password_hashing_algorithm/"},{"id":"check","summary":"Requests that run checks on all cluster nodes.","title":"Check all cluster nodes requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/check/"},{"id":"debuginfo","summary":"Documents the Redis Enterprise Software REST API /cluster/debuginfo requests.","title":"Cluster debug info requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/debuginfo/"},{"id":"ldap","summary":"LDAP configuration requests","title":"Cluster LDAP requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/ldap/"},{"id":"module-capabilities","summary":"Redis module capabilities requests","title":"Cluster module capabilities requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/module-capabilities/"},{"id":"policy","summary":"Cluster policy requests","title":"Cluster policy requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/policy/"},{"id":"services_configuration","summary":"Cluster services configuration requests","title":"Cluster services configuration requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/services_configuration/"},{"id":"stats","summary":"Cluster statistics requests","title":"Cluster stats requests","url":"https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/stats/"}]
}