Cluster policy requests

Cluster policy requests

Get cluster policy

GET /v1/cluster/policy

Gets the cluster's current policy settings.

Required permissions

Request

Example HTTP request

GET /v1/cluster/policy 

Request headers

Response

Returns a cluster settings object.

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

Update cluster policy

PUT /v1/cluster/policy

Update cluster policy settings.

Required permissions

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 with updated fields in the request body.

Response

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

Status codes