{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests/cluster/policy",
  "title": "Cluster policy requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/policy/",
  "summary": "Cluster policy requests",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-03-10T13:08:54-04:00",
  "page_type": "content",
  "content_hash": "4f07a5784315c5f241265e02c72ea29942f430a68f08317f973301e977076f67",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "| 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 |"
    },
    {
      "id": "get-cluster-policy",
      "title": "Get cluster policy",
      "role": "content",
      "text": "GET /v1/cluster/policy\n\nGets the cluster's current policy settings.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_cluster_info](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_cluster_info) |"
    },
    {
      "id": "get-request",
      "title": "Request",
      "role": "content",
      "text": "#### 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 |"
    },
    {
      "id": "get-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a [cluster settings object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cluster_settings).\n\n#### Example JSON body\n\n[code example]"
    },
    {
      "id": "get-status-codes",
      "title": "Status codes",
      "role": "content",
      "text": "| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success |"
    },
    {
      "id": "put-cluster-policy",
      "title": "Update cluster policy",
      "role": "content",
      "text": "PUT /v1/cluster/policy\n\nUpdate cluster policy settings.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [update_cluster](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#update_cluster) |"
    },
    {
      "id": "put-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n\tPUT /v1/cluster/policy\n\n#### Example JSON body\n\n[code example]\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](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cluster_settings) with updated fields in the request body."
    },
    {
      "id": "put-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a status code that indicates the success or failure of the cluster settings update."
    },
    {
      "id": "put-status-codes",
      "title": "Status codes",
      "role": "content",
      "text": "| 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 |"
    }
  ],
  "examples": [
    {
      "id": "get-response-ex0",
      "language": "json",
      "code": "{\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}",
      "section_id": "get-response"
    },
    {
      "id": "put-request-ex0",
      "language": "json",
      "code": "{\n    \"default_shards_placement\": \"sparse\",\n    \"default_sharded_proxy_policy\": \"all-nodes\"\n}",
      "section_id": "put-request"
    }
  ]
}