Policy

Get cluster policy {#get-cluster-policy}

GET /v1/cluster/policy

Gets the cluster's current policy settings.

Required permissions

Request {#get-request}

Example HTTP request

GET /v1/cluster/policy 

Request headers

Response {#get-response}

Returns a [cluster settings object]({{< relref "/operate/rs/references/rest-api/objects/cluster_settings" >}}).

Example JSON body

{
    "db_conns_auditing": false,
    "default_non_sharded_proxy_policy": "single",
    "default_provisioned_redis_version": "6.0",
    "default_sharded_proxy_policy": "single",
    "default_shards_placement": "dense",
    "redis_upgrade_policy": "major",
    "// additional fields..."
}

Status codes {#get-status-codes}

Update cluster policy {#put-cluster-policy}

PUT /v1/cluster/policy

Update cluster policy settings.

Required permissions

Request {#put-request}

Example HTTP request

PUT /v1/cluster/policy

Example JSON body

{
    "default_shards_placement": "sparse",
    "default_sharded_proxy_policy": "all-nodes"
}

Request headers

Request body

Include a [cluster settings object]({{< relref "/operate/rs/references/rest-api/objects/cluster_settings" >}}) with updated fields in the request body.

Response {#put-response}

Returns a status code that indicates the success or failure of the cluster settings update.

Status codes {#put-status-codes}