{
  "id": "policy",
  "title": "Cluster policy requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/policy/",
  "summary": "Cluster policy requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-cluster-policy) | `/v1/cluster/policy` | Get cluster policy settings |\n| [PUT](#put-cluster-policy) | `/v1/cluster/policy` | Update cluster policy settings |\n\n## Get cluster policy {#get-cluster-policy}\n\n\tGET /v1/cluster/policy\n\nGets the cluster's current policy settings.\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/policy \n\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 settings object]().\n\n#### Example JSON body\n\n```json\n{\n    \"db_conns_auditing\": false,\n    \"default_non_sharded_proxy_policy\": \"single\",\n    \"default_provisioned_redis_version\": \"6.0\",\n    \"default_sharded_proxy_policy\": \"single\",\n    \"default_shards_placement\": \"dense\",\n    \"redis_upgrade_policy\": \"major\",\n    \"// additional fields...\"\n}\n```\n\n### Status codes {#get-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |\n\n## Update cluster policy {#put-cluster-policy}\n\n\tPUT /v1/cluster/policy\n\nUpdate cluster policy settings.\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/policy\n\n#### Example JSON body\n\n```json\n{\n    \"default_shards_placement\": \"sparse\",\n    \"default_sharded_proxy_policy\": \"all-nodes\"\n}\n```\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#### Request body\n\nInclude a [cluster settings object]() with updated fields in the request body.\n\n### Response {#put-response} \n\nReturns a status code that indicates the success or failure of the cluster settings update.\n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |\n| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Failed to set parameters |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}