title: Search and query configuration object

title: Content

text:
Configuration fields for search and query.

| Field | Type/Value | Description |
|-------|------------|-------------|
| search-timeout | integer (range: 1-9223372036854775807) (default: 500) | The maximum amount of time in milliseconds that a search query is allowed to run. |
| search-ext-load | string  | If present, RediSearch will try to load an extension dynamic library from its specified file path. Requires a database restart to take effect. |
| search-max-doctablesize | integer (range: 1-18446744073709551615) (default: 1000000) | The maximum size of the internal hash table used for storing the documents. Requires a database restart to take effect. |
| search-friso-ini | string  | If present, load the custom Chinese dictionary from the specified path. Requires a database restart to take effect. |
| search-cursor-max-idle | integer (range: 1-9223372036854775807) (default: 300000) | The maximum idle time in milliseconds that can be set to the cursor api. |
| search-partial-indexed-docs | integer (range: 0-9223372036854775807) (default: 0) | Enable or turn off the Redis command filter. Requires a database restart to take effect. |
| search-gc-scan-size | integer (range: 1-9223372036854775807) (default: 100) | The bulk size of the internal GC used for cleaning up indexes. Requires a database restart to take effect. |
| search-no-gc | boolean (default: false) | If set, Garbage Collection is deactivated for all indexes. Requires a database restart to take effect. |
| search-fork-gc-run-interval | integer (range: 1-9223372036854775807) (default: 30) | Interval in seconds between two consecutive fork GC runs. |
| search-fork-gc-retry-interval | integer (range: 1-9223372036854775807) (default: 5) | Interval in seconds in which RediSearch will retry to run fork GC in case of a failure. |
| search-fork-gc-clean-threshold | integer (range: 1-9223372036854775807) (default: 100) | The fork GC will only start to clean when the number of not cleaned documents exceeds this threshold; otherwise, it will skip this run. |
| search-vss-max-resize | integer (range: 0-4294967295) (default: 0) | The maximum memory resize for vector similarity indexes in bytes. |
| search-union-iterator-heap | integer (range: 1-9223372036854775807) (default: 20) | The minimum number of iterators in a union from which the iterator will switch to heap-based implementation. |
| search-min-phonetic-term-len | integer (range: 1-9223372036854775807) (default: 3) | Minimum length of term to be considered for phonetic matching. |
| search-multi-text-slop | integer (range: 1-4294967295) (default: 100) | Set RediSearch delta used to increase positional offsets between array slots for multi-text values. Requires a database restart to take effect. |
| search-raw-docid-encoding | boolean (default: false) | Turn off compression for DocID inverted index. Boost CPU performance. Requires a database restart to take effect. |
| search-_print-profile-clock | boolean (default: true) | Turn off print of time for ft.profile. For testing only. |
| search-_free-resource-on-thread | boolean (default: true) | Determine whether some index resources are free on a second thread |
| search-_numeric-compress | boolean (default: false) | Enable legacy compression of double to float. |
| search-bg-index-sleep-gap | integer (range: 1-4294967295) (default: 100) | The number of iterations to run while performing background indexing before we call usleep(1) (sleep for 1 micro-second) and make sure that we allow Redis to process other commands. Requires a database restart to take effect. |
| search-_numeric-ranges-parents | integer (range: 0-2) (default: 0) | Keep numeric ranges in numeric tree parent nodes of leaves for `x` |
| search-fork-gc-sleep-before-exit | integer (range: 0-9223372036854775807) (default: 0) | Set the number of seconds for the fork GC to sleep before exists, should always be set to 0 (other then on tests). |
| search-no-mem-pools | boolean (default: false) | Set RediSearch to run without memory pools. Requires a database restart to take effect. |
| search-_prioritize-intersect-union-children | boolean (default: false) | Intersection iterator orders the children iterators by their relative estimated number of results in ascending order. If the first iterators have a lower count of results, skips a larger number of results, which translates into faster iteration. If this flag is set, we use this optimization in a way where union iterators are being factorized by the number of their own children, so that we sort by the number of children times the overall estimated number of results instead. |
| search-conn-per-shard | integer (range: 0-9223372036854775807) (default: 0) | Number of connections to each shard in the cluster. Default to 0. If 0, the number of connections is set to `WORKERS` + 1. |
| search-cursor-reply-threshold | integer (range: 1-9223372036854775807) (default: 1) | Maximum number of replies to accumulate before triggering `_FT.CURSOR READ` on the shards |
| search-threads | integer  | Maximum number of replies to accumulate before triggering `_FT.CURSOR READ` on the shards. Requires a database restart to take effect. |
| search-default-dialect | integer (range: 1-4) (default: 1) | The default DIALECT to be used by FT.CREATE, FT.AGGREGATE, FT.EXPLAIN, FT.EXPLAINCLI, and FT.SPELLCHECK. |
| search-topology-validation-timeout | integer (range: 0-9223372036854775807) (default: 30000) | Sets the timeout for topology validation (in milliseconds). After this timeout, any pending requests will be processed, even if the topology is not fully connected. |
| search-workers | integer (range: 0-8192) (default: 0) | Number of worker threads to use for query processing and background tasks. |
| search-min-operation-workers | integer (range: 0-8192) (default: 4) | Number of worker threads to use for background tasks when the server is in an operation event. |
| search-tiered-hnsw-buffer-limit | integer (range: 0-9223372036854775807) (default: 1024) | Sets the buffer limit threshold for vector similarity tiered HNSW index. If using WORKERS for indexing and the number of vectors waiting in the buffer to be indexed exceeds this limit, inserts new vectors directly into HNSW. Requires a database restart to take effect. |
| search-workers-priority-bias-threshold | integer (range: 0-9223372036854775807) (default: 1) | The number of high-priority tasks to run at any given time by the worker thread pool, before executing low-priority tasks. After this number of high-priority tasks are running, the worker thread pool will run high and low-priority tasks alternately. Requires a database restart to take effect. |
| search-on-timeout | "RETURN"
"FAIL"
(default: "RETURN") | The response policy for queries that exceed the TIMEOUT setting can be one of the following: RETURN / FAIL |
| search-min-prefix | integer (range: 1-9223372036854775807) (default: 2) | The minimum number of characters allowed for prefix queries (e.g., hel*) |
| search-min-stem-len | integer (range: 2-4294967295) (default: 4) | The minimum word length to stem |
| search-max-prefix-expansions | integer (range: 1-9223372036854775807) (default: 200) | The maximum number of expansions allowed for query prefixes |
| search-max-search-results | integer (range: 0-9223372036854775807) (default: 1000000) | The maximum number of results to be returned by the FT.SEARCH command if LIMIT is used |
| search-max-aggregate-results | integer (range: 0-9223372036854775807) (default: 2147483648) | The maximum number of results to be returned by the FT.AGGREGATE command if LIMIT is used |
| search-io-threads | integer (range: 1-256) (default: 1) | The number of threads the coordinator is using for IO threads to handle network to/from other shards |
| search-enable-unstable-features | boolean (default: false) | Enable unstable features. |


title: Snapshot policy object

summary: Documents the snapshot_policy object used with Redis Software REST API calls.

page_type: content

title: Content

role: content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| secs   | integer | Interval in seconds between snapshots |
| writes | integer | Number of write changes required to trigger a snapshot |


title: BDB status field

summary: Documents the bdb status field used with Redis Software REST API calls.

title: Content

text:
The BDB status field is a read-only field that represents the database status.

Possible status values:

| Status | Description | Possible next status |
|--------|-------------|----------------------|
| 'active' | Database is active and no special action is in progress | 'active-change-pending'
'import-pending'
'delete-pending' |
| 'active-change-pending' | |'active' |
| 'creation-failed' | Initial database creation failed | |
| 'delete-pending' | Database deletion is in progress | |
| 'import-pending' | Dataset import is in progress | 'active' |
| 'pending' | Temporary status during database creation | 'active'
'creation-failed' |
| 'recovery' | Not currently relevant (intended for future use) | |


title: Syncer sources object

summary: Documents the syncer_sources object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Unique ID of this source |
| client_cert | string | Client certificate to use if encryption is enabled |
| client_key | string | Client key to use if encryption is enabled |
| compression | integer, <nobr>(range: 0-6)</nobr> | Compression level for the replication link |
| encryption | boolean | Encryption enabled/disabled |
| lag | integer | Lag in milliseconds between source and destination (while synced) |
| last_error | string | Last error encountered when syncing from the source |
| last_update | string | Time when we last received an update from the source |
| rdb_size | integer | The source's RDB size to be transferred during the syncing phase |
| rdb_transferred | integer | Number of bytes transferred from the source's RDB during the syncing phase |
| replication_tls_sni | string | Replication TLS server name indication |
| server_cert | string | Server certificate to use if encryption is enabled |
| status | string | Sync status of this source |
| uri | string | Source Redis URI |


title: Timeseries configuration object

summary: Configuration object timeseries.

title: Content

text:
Configuration fields for timeseries.

| Field | Type/Value | Description |
|-------|------------|-------------|
| ts-num-threads | integer (range: 1-16) | Number of threads for time series operations. Requires a database restart to take effect. |
| ts-compaction-policy | string  | Default compaction rules. This default value is applied to each new time series upon its creation |
| ts-retention-policy | integer (range: 0-9223372036854775807) (default: 0) | Default retention period, in milliseconds. This default value is applied to each new time series upon its creation, but if COMPACTION_POLICY is specified, it is overridden for created compactions as specified in COMPACTION_POLICY. |
| ts-duplicate-policy | "BLOCK"
"FIRST"
"LAST"
"MIN"
"MAX"
"SUM"
(default: "BLOCK") | Default policy for handling insertion of multiple samples with identical timestamps. This default value is applied to each new time series upon its creation. |
| ts-encoding | "COMPRESSED"
"UNCOMPRESSED"
(default: "COMPRESSED") | Default chunk encoding for automatically-created compacted time series. This default value is applied to each new compacted time series automatically created due to the creation of a new time series when COMPACTION_POLICY is specified. |
| ts-chunk-size-bytes | integer (range: 48-1048576) (default: 4096) | Default initial allocation size, in bytes, for the data part of each new chunk. This default value is applied to each new time series upon its creation. |
| ts-ignore-max-time-diff | integer (range: 0-9223372036854775807) (default: 0) | Default maximum time difference that can be expired to consider a new insertion to be a duplicate. This default value is applied to each new time series upon its creation. |
| ts-ignore-max-val-diff | number (default: 0) | Default maximum value difference for a new insertion to be considered a duplicate. This default value is applied to each new time series upon its creation. |


title: BDB group object

summary: An object that represents a group of databases with a shared memory pool

title: Content

text:
An API object that represents a group of databases that share a memory pool.

| Name | Type/Value | Description |
|------|------------|-------------|
| uid          | integer          | Cluster unique ID of the database group |
| members      | array of strings | A list of UIDs of member databases (read-only) |
| memory_size  | integer          | The common memory pool size limit for all databases in the group, expressed in bytes |


title: Cluster identity object

summary: Documents the cluster_identity object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| name          | string                | Fully qualified cluster name. Limited to 64 characters and must comply with the IETF's RFC 952 standard and section 2.1 of the RFC 1123 standard. |
| nodes         | array of strings       | Array of IP addresses of existing cluster nodes |
| wait_command  | boolean (default: true) | Supports Redis wait command |


title: Credentials object

summary: Documents the credentials object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| password   | string       | Admin password |
| username   | string       | Admin username (pattern does not allow special characters &,\<,>,") |


title: Identity object

summary: Documents the identity object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Assumed node's UID to join cluster. Used to replace a dead node with a new one. |
| accept_servers | boolean (default: true) | If true, no shards will be created on the node |
| addr | string | Internal IP address of node |
| external_addr | complex object | External IP addresses of node. `GET` `/jsonschema` to retrieve the object's structure. |
| name | string | Node's name |
| override_rack_id | boolean | When replacing an existing node in a rack-aware cluster, allows the new node to be located in a different rack |
| rack_id | string | Rack ID, overrides cloud config |
| second_rack_id | string | Second rack ID where node is installed |
| use_internal_ipv6 | boolean (default: false) | Node uses IPv6 for internal communication |


title: Bootstrap object

summary: An object for bootstrap configuration

title: Cluster identity object

title: Credentials object

title: Identity object

summary: Documents the limits object used with Redis Software REST API calls.

title: Limits object

summary: Documents the node_identity object used with Redis Software REST API calls.

title: Node identity object

summary: Documents the paths object used with Redis Software REST API calls.

title: Paths object

summary: Documents the policy object used with Redis Software REST API calls.

title: Policy object

summary: An object for user-defined module configuration during bootstrap

title: user_defined_module object

title: Content

text:
A bootstrap configuration object.

| Name | Type/Value | Description |
|------|------------|-------------|
| action | 'create_cluster'
'join_cluster'
'recover_cluster' | Action to perform |
| cluster | [cluster_identity]() object | Cluster to join or create |
| cnm_https_port | integer | Port to join a cluster with non-default cnm_https port |
| crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port |
| credentials | [credentials]() object | Cluster admin credentials |
| dns_suffixes | object | Explicit configuration of DNS suffixes

[{
  "name": string,
  "cluster_default": boolean,
  "use_aaaa_ns": boolean,
  "use_internal_addr": boolean,
  "slaves": array
}, ...]

**name**: DNS suffix name
**cluster_default**: Should this suffix be the default cluster suffix
**use_aaaa_ns**: Should AAAA records be published for NS records
**use_internal_addr**: Should internal cluster IPs be published for databases
**slaves**: List of replica servers that should be published as NS and notified |
| envoy_admin_port | integer, (range: 1024-65535) | Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.|
| envoy_mgmt_server_port | integer, (range: 1024-65535) | Envoy management server port|
| gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port (deprecated; this port is no longer used because gossip functionality is handled by the main envoy process on `envoy_admin_port`) |
| license | string | License string. If not provided, a trial license is set by default. |
| max_retries | integer | Max number of retries in case of recoverable errors |
| node | [node_identity]() object | Node description |
| policy | [policy]() object | Policy object (deprecated; use [`PUT /v1/cluster/policy`]() after cluster creation instead) |
| recovery_filename | string | Name of backup file to recover from |
| required_version | string | This node can only join the cluster if all nodes in the cluster have a version greater than the required_version (deprecated as of Redis Software v7.8.6) |
| retry_time | integer | Max waiting time between retries (in seconds) |
| user_defined_modules | array of [user_defined_module]() objects | List of custom modules to download and install during bootstrap. Each node downloads and installs the modules independently. |
| witness_disk | object | An API object that represents the Witness Disk bootstrap configuration |


title: Limits object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| max_listeners      | integer (default: 100)    | Max allowed listeners on node |
| max_redis_servers  | integer (default: 100)    | Max allowed Redis servers on node |


title: Node identity object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| bigstore_driver | 'rocksdb' | Bigstore driver name or none (deprecated, use the [cluster object]()'s `bigstore_driver` instead) |
| bigstore_enabled | boolean (default: false) | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering]() databases. Configurable during [bootstrapping](). After bootstrapping, it is read-only. |
| identity | [identity]() object | Node identity |
| limits | [limits]() object | Node limits |
| paths | [paths]() object | Storage paths object |


title: Paths object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| bigstore_path | string | Bigredis storage path |
| ccs_persistent_path | string | Persistent storage path of CCS |
| ephemeral_path | string | Ephemeral storage path |
| persistent_path | string | Persistent storage path |


title: Policy object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| default_fork_evict_ram | boolean (default: false) | If true, the databases should evict data from RAM to ensure successful replication or persistence |
| default_non_sharded_proxy_policy | **'single'**
'all-master-shards'
'all-nodes' | Default proxy_policy for newly created non-sharded databases' endpoints |
| default_sharded_proxy_policy | 'single'
 **'all-master-shards'**
'all-nodes' | Default proxy_policy for newly created sharded databases' endpoints |
| default_shards_placement | 'dense'
 **'sparse'** | Default shards_placement for newly created databases |
| rack_aware | boolean | Cluster rack awareness |
| shards_overbooking | boolean (default: true) | If true, all databases' memory_size settings are ignored during shards placement |


title: user_defined_module object

title: Overview

role: overview

text:
A user-defined module configuration object for bootstrap operations.

| Name | Type/Value | Description |
|------|------------|-------------|
| name | string | Module name for presentation and logging purposes (required) |
| location | object | Information on where to download the module from (required)
{
  "location_type": "http | https",
  "url": "string",
  "credentials": {
    "username": "string",
    "password": "string"
  }
}
**location_type**: The type of location, either `http` or `https` (required)
**url**: The URL to download the module zip file from (required)
**credentials**: Optional credentials for downloads that require basic authentication |

title: Module package requirements

text:
The module must be packaged as a `.zip` file containing:

- **module.json**: A metadata file with module information including:
  - `module_name`: The actual module name
  - `version`: Numeric version
  - `semantic_version`: Semantic version string (for example, "1.0.0")
  - `min_redis_version`: Minimum compatible Redis version
  - `commands`: List of commands the module provides
  - `capabilities`: List of module capabilities

- **Module binary**: The compiled `.so` file for the target platform


title: Certificates object

summary: An object that represents a certificate

title: Content

text:
An API object that represents a certificate used by a Redis Software cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| name | "cm"
"api"
"mtls_trusted_ca"
"proxy"
"metrics_exporter"
"syncer"
"ldap_client"
"ccs_internode_encryption"
"data_internode_encryption"
"sso_service"
"sso_issuer" | Certificate type.
See the [certificates table]() for the list of cluster certificates and their descriptions. |
| certificate | string | The certificate in PEM format |
| key | string | The private key in PEM format |


title: Check result object

summary: An object that contains the results of a cluster check

title: Content

text:
Cluster check result

| Name | Type/Value | Description |
|------|------------|-------------|
| cluster_test_result | boolean | Indication if any of the tests failed |
| nodes |
[{
  "node_uid": integer,
  "result": boolean,
  "error": string
}, ...]
 | Nodes results |


title: Alert settings object

summary: Documents the alert_settings object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cluster_certs_about_to_expire | [cluster_alert_settings_with_threshold]() object | Cluster certificate will expire in x days |
| cluster_even_node_count | boolean (default: false) | True high availability requires an odd number of nodes in the cluster |
| cluster_flash_overcommit | boolean (default: false) | Flash memory committed to databases is larger than cluster total flash memory |
| cluster_inconsistent_rl_sw | boolean (default: false) | Some nodes in the cluster are running different versions of Redis Software |
| cluster_internal_bdb | boolean (default: false) | Issues with internal cluster databases |
| cluster_license_about_to_expire | [cluster_alert_settings_with_threshold]() object | Cluster license will expire in x days. This alert is enabled by default. Its default threshold is 7 days before license expiration. |
| cluster_multiple_nodes_down | boolean (default: false) | Multiple cluster nodes are down (this might cause data loss) |
| cluster_node_joined | boolean (default: false) | New node joined the cluster |
| cluster_node_remove_abort_completed | boolean (default: false) | Cancel node remove operation completed |
| cluster_node_remove_abort_failed | boolean (default: false) | Cancel node remove operation failed |
| cluster_node_remove_completed | boolean (default: false) | Node removed from the cluster |
| cluster_node_remove_failed | boolean (default: false) | Failed to remove a node from the cluster |
| cluster_ocsp_query_failed | boolean (default: false) | Failed to query the OCSP server |
| cluster_ocsp_status_revoked | boolean (default: false) | OCSP certificate status is REVOKED |
| cluster_ram_overcommit | boolean (default: false) | RAM committed to databases is larger than cluster total RAM |
| cluster_too_few_nodes_for_replication | boolean (default: false) | Replication requires at least 2 nodes in the cluster |
| cluster_users_count_approaches_limit | [cluster_alert_settings_with_threshold]() object | Number of users approaches the maximum limit of 32,000 users. This alert is enabled with a 90% threshold by default on new clusters. |
| node_aof_slow_disk_io | boolean (default: false) | AOF reaching disk I/O limits
| node_checks_error | boolean (default: false) | Some node checks have failed |
| node_cpu_utilization | [cluster_alert_settings_with_threshold]() object | Node CPU utilization has reached the threshold value (% of the utilization limit) |
| node_ephemeral_storage | [cluster_alert_settings_with_threshold]() object | Node ephemeral storage has reached the threshold value (% of the storage limit) |
| node_failed | boolean (default: false) | Node failed |
| node_free_flash | [cluster_alert_settings_with_threshold]() object | Node flash storage has reached the threshold value (% of the storage limit) |
| node_insufficient_disk_aofrw | boolean (default: false) | Insufficient AOF disk space |
| node_internal_certs_about_to_expire | [cluster_alert_settings_with_threshold]() object| Internal certificate on node will expire in x days |
| node_memory | [cluster_alert_settings_with_threshold]() object | Node memory has reached the threshold value (% of the memory limit) |
| node_net_throughput | [cluster_alert_settings_with_threshold]() object | Node network throughput has reached the threshold value (bytes/s) |
| node_persistent_storage | [cluster_alert_settings_with_threshold]() object | Node persistent storage has reached the threshold value (% of the storage limit) |


title: Cluster alert settings with threshold object

summary: Documents the cluster_alert_settings_with_threshold object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| enabled    | boolean (default: false)  | Alert enabled or disabled |
| threshold  | string                    | Threshold for alert going on/off |


title: Cluster object

summary: An object that represents a cluster

title: Alert settings object

summary: Documents the logrotate_settings object used with Redis Software REST API calls.

title: Logrotate settings object

title: Content

text:
An API object that represents the cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| alert_settings | [alert_settings]() object | Cluster and node alert settings |
| availability_lag_tolerance_ms | integer (default: 100) | The maximum replication lag in milliseconds tolerated between source and replicas during [lag-aware database availability checks](). |
| bigstore_driver | "speedb"
"rocksdb" | Storage engine for [Redis Flex or Auto Tiering]() |
| cluster_ssh_public_key | string | Cluster's autogenerated SSH public key |
|  client_maint_notifications | boolean (default: false) | Toggles sending client maintenance notifications about shard movements |
| cm_port | integer, (range: 1024-65535) | UI HTTPS listening port |
| cm_session_timeout_minutes | integer (default: 15) | The timeout (in minutes) for the session to the CM |
| cnm_http_max_threads_per_worker | integer (default: 10) | Maximum number of threads per worker in the `cnm_http` service (deprecated) |
| cnm_http_port | integer, (range: 1024-65535) | API HTTP listening port |
| cnm_http_workers | integer (default: 1) | Number of workers in the `cnm_http` service |
| cnm_https_port | integer, (range: 1024-65535) | API HTTPS listening port |
| control_cipher_suites | string | Specifies the enabled ciphers for the control plane. The ciphers are specified in the format understood by the BoringSSL library. |
| control_cipher_suites_tls_1_3 | string | Specifies the enabled TLS 1.3 ciphers for the control plane. The ciphers are specified in the format understood by the BoringSSL library. (read-only) |
| crdb_coordinator_port | integer, (range: 1024-65535) (default: 9081) | CRDB coordinator port |
| crdt_rest_client_retries | integer | Maximum number of retries for the REST client used by the Active-Active management API |
| crdt_rest_client_timeout | integer | Timeout for REST client used by the Active-Active management API |
| created_time | string | Cluster creation date (read-only) |
| data_cipher_list | string | Specifies the enabled ciphers for the data plane. The ciphers are specified in the format understood by the OpenSSL library. |
| data_cipher_suites_tls_1_3 | string | Specifies the enabled TLS 1.3 ciphers for the data plane. |
| debuginfo_path | string | Path to a local directory used when generating support packages |
| default_non_sharded_proxy_policy | string (default: single) | Default proxy_policy for newly created non-sharded databases' endpoints (read-only) |
| default_sharded_proxy_policy | string (default: all-master-shards) | Default proxy_policy for newly created sharded databases' endpoints (read-only) |
| disconnect_clients_on_password_removal | "enabled"
"disabled"
**"auto"** | This flag controls whether client connections using removed, revoked, or rotated passwords are actively disconnected |
| email_alerts | boolean (default: false) | Send node/cluster email alerts (requires valid SMTP and email_from settings) |
| email_from | string | Sender email for automated emails |
| encrypt_pkeys | boolean (default: false) | Enable or turn off encryption of private keys |
| envoy_admin_port | integer, (range: 1024-65535) | Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.|
| envoy_max_downstream_connections | integer, (range: 100-2048) | The max downstream connections envoy is allowed to open |
| envoy_mgmt_server_port | integer, (range: 1024-65535) | Envoy management server port|
| gossip_envoy_admin_port | integer, (range: 1024-65535) | Gossip envoy admin port (deprecated; this port is no longer used because gossip functionality is handled by the main envoy process on `envoy_admin_port`) |
| handle_redirects | boolean (default: false) | Handle API HTTPS requests and redirect to the master node internally |
| http_support | boolean (default: false) | Enable or turn off HTTP support |
| logrotate_settings | [logrotate_settings]() object | Settings for logrotate configuration |
| metrics_auth | boolean (default: false) | If true, requires authentication for requests to the metrics exporter |
| min_control_TLS_version | "1.2"
"1.3" | The minimum version of TLS protocol which is supported at the control path |
| min_data_TLS_version | "1.2"
"1.3" | The minimum version of TLS protocol which is supported at the data path |
| min_sentinel_TLS_version | "1.2"
"1.3" | The minimum version of TLS protocol which is supported at the data path |
| mtls_authorized_subjects | array | [{
  "CN": string,
  "O": string,
  "OU": [array of strings],
  "L": string,
  "ST": string,
  "C": string
}, ...] A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.
**Required subject fields**:
"CN" for Common Name
**Optional subject fields:**
"O" for Organization
"OU" for Organizational Unit (array of strings)
"L" for Locality (city)
"ST" for State/Province
"C" for 2-letter country code |
| mtls_certificate_authentication | boolean | Require authentication of client certificates for mTLS connections to the cluster. The API_CA certificate should be configured as a prerequisite. |
| mtls_client_cert_subject_validation_type | "disabled"
"san_cn"
"full_subject" | Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.
Values:
**disabled**: Authenticates clients with valid certificates. No additional validations are enforced.
**san_cn**: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.
**full_subject**: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects. |
| multi_commands_opt | **"disabled"**
"batch"
"force_disabled" | Determines the default `multi_commands_opt` setting for databases in the cluster. If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.
Values:
**disabled**: Turns off the optimization for all databases except those that override it on the [bdb level](). Default value.
**batch**: Enables the optimization on all databases except those that override it on the [bdb level]().
**force_disabled**: Disables the optimization for all databases, even those that override it on the [bdb level](). |
| name | string | Cluster's fully qualified domain name (read-only) |
| options_method_forbidden | boolean (default: false) | Make OPTIONS http method forbidden over CNM HTTPS port. |
| password_complexity | boolean (default: false) | Enforce password complexity policy |
| password_expiration_duration | integer (default: 0) | The number of days a password is valid until the user is required to replace it |
| password_min_length | integer, (range: 8-256) (default: 8) | The minimum length required for a password. |
| proxy_certificate | string | Cluster's proxy certificate |
| proxy_max_ccs_disconnection_time | integer | Cluster-wide proxy timeout policy between proxy and CCS |
| rack_aware | boolean | Cluster operates in a rack-aware mode (read-only) |
| reserved_ports | array of strings | List of reserved ports and/or port ranges to avoid using for database endpoints (for example `"reserved_ports": ["11000", "13000-13010"]`) |
| replica_sconns_on_demand | "enabled"
"disabled"
**"auto"** | Reduces DMC internode connections by at least 50%, conserving sockets, file descriptors, and `KEEPALIVE` traffic |
| robust_crdt_syncer | boolean (default: false) | If `true`, enables the robust syncer for Active-Active databases |
| s3_ca_cert | string | Filepath to the PEM-encoded CA certificate to use for validating TLS connections to the S3 server |
| s3_url | string | Specifies the URL for S3 export and import |
| sentinel_cipher_suites | array | Specifies the list of enabled ciphers for the sentinel service. The supported ciphers are those implemented by the [cipher_suites.go](<https://golang.org/src/crypto/tls/cipher_suites.go>) package. |
| sentinel_cipher_suites_tls_1_3 | string | Specifies the list of enabled TLS 1.3 ciphers for the discovery (sentinel) service. The supported ciphers are those implemented by the [cipher_suites.go](<https://golang.org/src/crypto/tls/cipher_suites.go>) package.(read-only) |
| sentinel_tls_mode | "allowed"
"disabled"
"required" | Determines whether the discovery service allows, blocks, or requires TLS connections (previously named `sentinel_ssl_policy`)
**allowed**: Allows both TLS and non-TLS connections
**disabled**: Allows only non-TLS connections
**required**: Allows only TLS connections |
| slave_ha | boolean (default: false) | Enable the replica high-availability mechanism (read-only) |
| slave_ha_bdb_cooldown_period | integer (default: 86400) | Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database (read-only) |
| slave_ha_cooldown_period | integer (default: 3600) | Time in seconds between runs of the replica high-availability mechanism on different nodes (read-only) |
| slave_ha_grace_period | integer (default: 900) | Time in seconds between a node failure and when the replica high-availability mechanism starts relocating shards (read-only) |
| slowlog_in_sanitized_support | boolean | Whether to include slowlogs in the sanitized support package |
| smtp_host | string | SMTP server for automated emails |
| smtp_password | string | SMTP server password |
| smtp_port | integer | SMTP server port for automated emails |
| smtp_tls_mode | "none"
"starttls"
"tls" | Specifies which TLS mode to use for SMTP access |
| smtp_use_tls | boolean (default: false) | Use TLS for SMTP access (deprecated as of Redis Software v4.3.3, use smtp_tls_mode field instead) |
| smtp_username | string | SMTP server username (pattern does not allow special characters &,\<,>,") |
| state_machine_smart_client_handoffs_delay_ms | integer (range: 0-10000) (default: 2000) | For smart client handoffs feature, the time in milliseconds to pause the state machine between sending the notification to clients and performing the operation |
| syncer_certificate | string | Cluster's syncer certificate |
| upgrade_mode | boolean (default: false) | Is cluster currently in upgrade mode |
| use_external_ipv6 | boolean (default: true) | Should redislabs services listen on ipv6 |
| use_ipv6 | boolean (default: true) | Should redislabs services listen on ipv6 (deprecated as of Redis Software v6.4.2, replaced with use_external_ipv6) |
| wait_command | boolean (default: true) | Supports Redis wait command (read-only) |


title: Logrotate settings object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| maxage | integer (default: 7) | Remove rotated logs older than the specified number of days |
| maxsize | string (default: 200M) | The log will rotate after it reaches the specified size |
| rotate | integer (default: 10) | Determines how many times the log will be rotated. If set to 0, old versions are removed rather than rotated. |


title: Cluster settings object

summary: An object for cluster resource management settings

title: Content

text:
Cluster resources management policy

| Name | Type/Value | Description |
|------|------------|-------------|
| acl_pubsub_default | `resetchannels`
 `allchannels` | Default pub/sub ACL rule for all databases in the cluster:
•`resetchannels` blocks access to all channels (restrictive)
•`allchannels` allows access to all channels (permissive) |
| auto_recovery | boolean (default: false) | Defines whether to use automatic recovery after shard failure |
| automatic_node_offload | boolean (default: true) | Defines whether the cluster will automatically migrate shards from a node, in case the node is overbooked |
| bigstore_migrate_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory |
| bigstore_migrate_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory |
| bigstore_provision_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it |
| bigstore_provision_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it |
| data_internode_encryption | boolean | Enable/deactivate encryption of the data plane internode communication |
| db_conns_auditing | boolean | [Audit connections]() for new databases by default if set to true. |
| default_bigstore_version | **`1`**
`2` | Determines the default value of `bigstore_version` for new databases with Redis version 7.4:
• `1` for Auto Tiering (Redis on Flash version 1). Default version.
• `2` for Redis Flex (Redis on Flash version 2) on databases that support it. Can only be used with the `speedb` driver. |
| default_concurrent_restore_actions | integer | Default number of restore actions allowed at the same time. Set to 0 to allow any number of simultaneous restore actions. |
| default_fork_evict_ram | boolean | If true, the bdbs should evict data from RAM to ensure successful replication or persistence |
| default_non_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default proxy_policy for newly created non-sharded databases' endpoints |
| default_oss_sharding | boolean (default: false) | Default hashing policy to use for new databases. This field is for future use only and should not be changed. |
| default_oss_cluster | boolean (default: false) | Default `oss_cluster` setting for new databases. Enables the OSS Cluster API if `true`, or turns it off if `false`. |
| default_provisioned_redis_version | string | Default Redis version |
| default_recovery_wait_time | integer (default: -1) | The default time for new databases to wait for the persistence file to be available during automatic recovery. -1 means wait forever. |
| default_sharded_proxy_policy | `single`

`all-master-shards`

`all-nodes` | Default proxy_policy for newly created sharded databases' endpoints |
| default_shards_placement | `dense`
`sparse` | Default shards_placement for a newly created databases |
| default_tracking_table_max_keys_policy | integer (default: 1000000) | Defines the default value of the client-side caching invalidation table size for new databases. 0 makes the cache unlimited. |
| diskless_repl | `yes`
`no` (default: yes) | If `yes`, enable default Redis diskless replication mechanism (deprecated; use `repl_diskless` instead) |
| endpoint_rebind_propagation_grace_time | integer | Time to wait between the addition and removal of a proxy |
| evict_node_use_free_memory | boolean | When evicting a node, use the free memory instead of the provisional memory to check if the shards from the old node fit on the new one |
| expose_hostnames_for_all_suffixes | boolean (default: false) | If true, enables exposing hostnames for non-default DNS suffixes |
| failure_detection_sensitivity | `high`
`low` | Predefined thresholds and timeouts for failure detection (previously known as `watchdog_profile`)
• `high` (previously `local-network`) – high failure detection sensitivity, lower thresholds, faster failure detection and failover
• `low` (previously `cloud`) – low failure detection sensitivity, higher tolerance for latency variance (also called network jitter) |
| filter_node_wd_health_metrics | boolean (default: true) | When enabled, `node_wd` health metrics (`shard_ping_failures`, `endpoint_ping_failures`, `dmc_ping_failures` and their duration counterparts) are not emitted to `statsd` |
| hide_user_data_from_log | boolean (default: false) | Set to `true` to enable the `hide-user-data-from-log` Redis configuration setting, which avoids logging user data |
| login_lockout_counter_reset_after | integer | Number of seconds that must elapse between failed sign in attempts before the lockout counter is reset to 0. |
| login_lockout_duration | integer | Duration (in secs) of account lockout. If set to 0, the account lockout will persist until released by an admin. |
| login_lockout_threshold | integer | Number of failed sign in attempts allowed before locking a user account |
| master_healthcheck_api_auth | boolean (default: true) | Defines if authentication is required by the local `master_healthcheck` API |
| max_redis_forks | integer (default: 0) | Maximum number of background processes forked from shards that can exist on the node at any given time. 0 means unlimited. |
| max_saved_events_per_type | integer | Maximum saved events per event type |
| max_simultaneous_backups | integer (default: 4) | Maximum number of backup processes allowed at the same time |
| metrics_exporter_expose_bdb_name | boolean (default: false) | If true, adds a label with the database name to relevant metrics |
| parallel_shards_upgrade | integer | Maximum number of shards to upgrade in parallel |
| max_slave_full_syncs | integer (default: 0) | Maximum number of simultaneous replica full syncs that can run at any given time. 0 means unlimited. |
| oss_cluster_api_preferred_endpoint_type | `ip`
`hostname` (default: ip) | Determines the default endpoint type in the OSS Cluster API for new endpoints |
| oss_cluster_api_preferred_ip_type | `internal`
`external` (default: internal) | Determines the default IP type in the OSS Cluster API for new endpoints |
| persistence_cleanup_grace_time | integer | Time in seconds before an unmodified file is considered to be stale and to be removed by persistence cleanup |
| persistence_cleanup_scan_interval | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |
| persistent_node_removal | boolean | When removing a node, wait for persistence files to be created for all migrated shards |
| rack_aware | boolean | Cluster operates in a rack-aware mode |
| redis_migrate_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory |
| redis_migrate_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before automatic migration of shards from it to free more memory |
| redis_provision_node_threshold | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it |
| redis_provision_node_threshold_p | integer | Minimum free memory (excluding reserved memory) allowed on a node before new shards can no longer be added to it |
| redis_upgrade_policy | **`major`**
`latest` | Create/upgrade Redis Software on databases in the cluster by compatibility with major versions or latest versions of Redis Open Source |
| repl_diskless | boolean (default: true) | If true, enables the default Redis diskless replication mechanism |
| resp3_default | boolean (default: true) | Determines the default value of the `resp3` option upon upgrading a database to version 7.2 |
| shards_overbooking | boolean | If true, all databases' memory_size is ignored during shards placement |
| show_internals | boolean | Show internal databases (and their shards and endpoints) REST APIs |
| show_metrics_during_state_machine | boolean | Show metrics during state machine operations |
| slave_ha | boolean | Enable the replica high-availability mechanism. Deprecated as of Redis Software v7.2.4. |
| slave_ha_bdb_cooldown_period | integer | Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database |
| slave_ha_cooldown_period | integer | Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database |
| slave_ha_grace_period | integer | Time in seconds between a node failure and when the replica high-availability mechanism starts relocating shards |
| slow_log_max_len | integer (default: 1024) | Set max slow log entries in debug info |
| use_librdb | boolean | If true, new databases use the new RDB parser instead of the old one |
| witness_disk_update_frequency_divisor | integer (default: 3) | Redis Software updates the witness disk every `node_max_update_time / witness_disk_update_frequency_divisor` seconds |


title: Cluster Manager settings object

summary: A REST API object that represents Cluster Manager UI settings

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| timezone | string | Configurable [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the Cluster Manager UI. The default time zone is UTC. |


title: CRDB cluster info object

summary: An object that represents Active-Active cluster info

title: Content

text:
Configuration details for a cluster that is part of an Active-Active database.

| Name | Type/Value | Description |
|------|------------|-------------|
| credentials |
{
  "username": string,
  "password": string
}  | Cluster access credentials (required) |
| name | string | Cluster fully qualified name, used to uniquely identify the cluster. Typically this is the same as the hostname used in the URL, although in some configruations the URL may point to a different name/address. (required) |
| replication_endpoint | string | Address to use for peer replication. If not specified, it is assumed that standard cluster naming conventions apply. |
| replication_tls_sni | string | Cluster SNI for TLS connections |
| url | string | Cluster access URL (required) |


title: CRDB database config object

title: Content

text:
An object that represents the database configuration. This configuration object is used in two contexts within CRDB objects:

- As `default_db_config` in the main [CRDB object]() for settings that apply to all instances. In most cases, instances should use the same configuration.

- As `db_config` in individual [instance objects]() to override `default_db_config` or add configuration values for specific instances. Use `db_config` only when an instance needs different settings than the default configuration.

| Name | Type/Value | Description |
|------|------------|-------------|
| aof_policy | **'appendfsync-every-sec'**
'appendfsync-always' | Policy for Append-Only File data persistence |
| authentication_admin_pass | string | Administrative databases access token |
| authentication_redis_pass | string | Redis AUTH password (deprecated as of Redis Software v7.2, replaced with multiple passwords feature in version 6.0.X) |
| bigstore | boolean (default: false) | Database driver is Auto Tiering |
| bigstore_ram_size | integer (default: 0) | Memory size of RAM size |
| cert | string | Optional PEM-encoded server certificate for the underlying database instance |
| data_persistence | 'disabled'
'snapshot'
**'aof'** | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]() must be provided |
| enforce_client_authentication | **'enabled'**
'disabled' | Require authentication of client certificates for SSL connections to the database. If enabled, a certificate should be provided in either `authentication_ssl_client_certs` or `authentication_ssl_crdt_certs` |
| authentication_ssl_client_certs | array | List of authorized client certificates. For Active-Active databases, it is strongly advised to configure the client certificates individually for each instance instead of using the default database configuration, even if the same certificate is used across all instances.
[{
  "client_cert": string
}, ...]
**client_cert**: X.509 PEM (Base64) encoded certificate |
| mtls_allow_outdated_certs | boolean (default: false) | An optional mTLS relaxation flag for certs verification |
| mtls_allow_weak_hashing | boolean (default: false) | An optional mTLS relaxation flag for certs verification |
| max_aof_file_size | integer | Maximum AOF file size in bytes |
| max_aof_load_time | integer (default: 3600) | Maximum AOF reload time in seconds |
| memory_size | integer (default: 0) | Database memory size limit in bytes. 0 is unlimited. |
| module_list | array of module objects | List of modules to be loaded to all participating clusters of the Active-Active database
[{
  "module_id": string,
  "module_args": string,
  "module_name": string,
  "semantic_version": string,
}, ...]
**module_id**: Module UID (deprecated; use `module_name` instead)
**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")
**module_name**: Module's name
**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)

**module_id** and **semantic_version** are optional as of Redis Software v7.4.2 and deprecated as of v7.8.2. |
| oss_cluster | boolean (default: false) | Enables OSS Cluster mode |
| oss_cluster_api_preferred_ip_type | 'internal'
'external' | Indicates preferred IP type in OSS cluster API |
| oss_sharding | boolean (default: false) | An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy |
| port | integer | TCP port for database access |
| private_key | string | Optional PEM-encoded private key matching the certificate for the underlying database instance |
| proxy_policy | 'single'
'all-master-shards'
'all-nodes' | The policy used for proxy binding to the endpoint |
| rack_aware | boolean (default: false) | Require the database to be always replicated across multiple racks |
| replication | boolean (default: true) | Database replication |
| sharding | boolean (default: false) | Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either `oss_sharding` or `shard_key_regex` |
| shard_key_regex | `[{ "regex": string }, ...]` | Custom keyname-based sharding rules (required if sharding is enabled)

To use the default rules you should set the value to:
`[{"regex": ".*\\{(?<tag>.*)\\}.*"}, {"regex": "(?<tag>.*)"}]` |
| shards_count | integer (range: 1-512) (default: 1) | Number of database shards |
| shards_placement | 'dense'
'sparse' | Control the density of shards
Values:
**'dense'**: Shards reside on as few nodes as possible
 **'sparse'**: Shards reside on as many nodes as possible |
| snapshot_policy | array of [snapshot_policy]() objects | Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset. |
| tls_mode | 'enabled'
 **'disabled'**
'replica_ssl' | Encrypt communication |


title: CRDB health report configuration object

title: Content

text:
An object that represents the database configuration to include in an Active-Active database health report.

| Name | Type/Value | Description |
|------|------------|-------------|
| causal_consistency | boolean | Enables causal consistency across Active-Active replicas |
| encryption | boolean | Intercluster encryption |
| featureset_version | integer | CRDB active FeatureSet version |
| instances | [{
  // Unique instance ID
  "id": integer,
  // Local database instance ID
  "db_uid": string,
  "cluster": {
    // Cluster FQDN
    "name": string
    // Cluster access URL
    "url": string
  }
}, ...]  | Local database instances  |
| name | string | Name of database |
| protocol_version | integer | CRDB active protocol version |
| status | string | Current status of the configuration.
Possible values:
**posted:**  Configuration was posted to all replicas
**ready:** All replicas have finished processing posted configuration (create a database)
**committed**: Posted configuration is now active on all replicas
**commit-completed:** All replicas have finished processing committed configuration (database is active)
**failed:** Configuration failed to post |
| version | integer | Database configuration version |


title: CRDB health report object

summary: An object that represents the database configuration to include in an Active-Active database health report.

title: CRDB health report configuration object

title: Content

text:
An object that represents an Active-Active database health report.

| Name | Type/Value | Description |
|------|------------|-------------|
| active_config_version | integer | Active configuration version |
| cluster_name | string | Name of local Active-Active cluster |
| configurations | array of [health_report_configuration]() objects | Stored database configurations |
| connection_error | string | Error string if remote cluster is not available |
| connections |
[{
  "name": string,
  "replication_links": [
    {
      "link_uid": "bdb_uid:replica_uid",
      "status": "up | down"
    } ],
  "status": string
}, ...]  | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb]()) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. |
| name | string | Name of the Active-Active database |


title: CRDB object

title: CRDB cluster info object

summary: An object that represents the database configuration

title: CRDB database config object

summary: An object that represents an Active-Active database health report.

title: CRDB health report object

summary: An object that represents Active-Active instance info

title: CRDB instance info object

summary: An object to update an Active-Active database

title: CRDB modify request object

title: Content

text:
An object that represents an Active-Active database.

| Name | Type/Value | Description |
|------|------------|-------------|
| guid | string | The global unique ID of the Active-Active database |
| causal_consistency | boolean | Enables causal consistency across CRDT instances |
| default_db_config| [CRDB database_config]() object | Default database configuration applied to all instances in the CRDB object. In most cases, instances should use the same configuration. If you need to override `default_db_config` or add configuration values for specific instances, you can use `db_config` in individual [instance objects](). |
| encryption | boolean | Encrypt communication |
| featureset_version | integer | Active-Active database active FeatureSet version
| instances | array of [CRDB instance_info]() objects | |
| local_databases | [{
  "bdb_uid": string,
  "id": integer
}, ...]  | Mapping of instance IDs for local databases to local BDB IDs |
| managed_by | string | The component that manages the Active-Active database |
| modules | [{
  "featureset_version": integer,
  "module_name": string
}, ...]  | Modules used by the Active-Active database |
| name | string | Name of Active-Active database |
| protocol_version | integer | Active-Active database active protocol version |
| volatile_config_fields | array of strings | A list of database configuration fields that will be set even if unchanged |


title: CRDB instance info object

title: Content

text:
An object that represents Active-Active instance info.

| Name | Type/Value | Description |
|------|------------|-------------|
| id | integer | Unique instance ID |
| cluster | [CRDB cluster_info]() object | |
| compression | integer | Compression level when syncing from this source |
| db_config | [CRDB database_config]() object | Database configuration for this specific instance. Use `db_config` only when you need to override or add configuration values that differ from the `default_db_config` in the main [CRDB object](). |
| db_uid | string | ID of local database instance. This field is likely to be empty for instances other than the local one. |


title: CRDB modify request object

title: Content

text:
An object to update an Active-Active database.

| Name | Type/Value | Description |
|------|------------|-------------|
| add_instances | array of [CRDB instance_info]() objects | List of new CRDB instances |
| crdb | [CRDB]() object | An object that represents an Active-Active database |
| force_update | boolean | (Warning: This flag can cause unintended and dangerous changes) Force the configuration update and increment the configuration version even if there is no change to the configuration parameters. If you use force, you can mistakenly cause the other instances to update to the configuration version even though it was not changed. |
| remove_instances | array of integers | List of unique instance IDs |
| remove_instances.force_remove | boolean | Force removal of instance from the Active-Active database. Before we remove an instance from an Active-Active database, all of the operations that the instance received from clients must be propagated to the other instances. This is the safe method to remove an instance from the Active-Active database. If the instance does not have connectivity to other instances, the propagation fails and removal fails. To remove an instance that does not have connectivity to other instances, you must use the force flag. The removed instance keeps its data and configuration for the instance. After you remove an instance by force, you must use the purge_instances API on the removed instance. |


title: CRDB task object

summary: An object that represents a CRDB task

title: Content

text:
An object that represents an Active-Active (CRDB) task.

| Name | Type/Value | Description |
|------|------------|-------------|
| id | string | CRDB task ID (read-only) |
| crdb_guid | string | Globally unique Active-Active database ID (GUID) (read-only) |
| ended | string | Timestamp when the task ended (read-only) |
| errors |
[{
  "cluster_name": string,
  "description": string,
  "error_code": string
}, ...]  | Details for errors that occurred on a cluster |
| operation | string | The operation that is running (read-only) |
| progress |
{
  "clusters": [{
    "name": string,
    "progress": string
  }, ...],
  "worker": string
}  | • `name`: The instance cluster name
• `progress`: The step the instance coordinator is running
• `worker`: The step the worker is running |
| started | string | Timestamp when the task started (read-only) |
| status | 'queued'
'started'
'finished'
'failed' | CRDB task status (read-only) |
| worker_name | string | The worker that runs the task (read-only) |


title: Database connection auditing configuration object

summary: An object for database connection auditing settings

title: Content

text:
Database connection auditing configuration

| Name | Type/Value | Description |
|------|------------|-------------|
| audit_address | string | TCP/IP address where one can listen for notifications. |
| audit_port | integer | Port where one can listen for notifications. |
| audit_protocol | `TCP`<br />`local` | Protocol used to process notifications. For production systems, `TCP` is the only valid value. |
| audit_reconnect_interval | integer | Interval (in seconds) between attempts to reconnect to the listener. Default is 1 second. |
| audit_reconnect_max_attempts | integer | Maximum number of attempts to reconnect. Default is 0 (infinite). |


title: BDB alert settings with threshold object

summary: Documents the bdb_alert_settings_with_threshold object used with Redis Enterprise Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| enabled    | boolean (default: false)  | Alert enabled or disabled |
| threshold  | string                         | Threshold for alert going on/off |


title: Database alerts settings object

summary: An object for database alerts configuration

title: Content

text:
An API object that represents the database alerts configuration.

| Name | Type/Value | Description |
|------|------------|-------------|
| bdb_backup_delayed | [bdb_alert_settings_with_threshold]() object | Periodic backup has been delayed for longer than specified threshold value (minutes) |
| bdb_crdt_src_high_syncer_lag | [bdb_alert_settings_with_threshold]() object | CRDB source sync lag is higher than specified threshold value (seconds) |
| bdb_crdt_src_syncer_connection_error | [bdb_alert_settings_with_threshold]() object | CRDB source sync had a connection error while trying to connect to replica source |
| bdb_crdt_src_syncer_general_error | [bdb_alert_settings_with_threshold]() object | CRDB sync encountered in general error |
| bdb_high_latency | [bdb_alert_settings_with_threshold]() object | Latency is higher than specified threshold value (microsec) |
| bdb_high_syncer_lag | [bdb_alert_settings_with_threshold]() object | Replica of sync lag is higher than specified threshold value (seconds) (deprecated as of Redis Software v5.0.1) |
| bdb_high_throughput | [bdb_alert_settings_with_threshold]() object | Throughput is higher than specified threshold value (requests / sec) |
| bdb_long_running_action | [bdb_alert_settings_with_threshold]() object | An alert for state machines that are running for too long |
| bdb_low_throughput | [bdb_alert_settings_with_threshold]() object | Throughput is lower than specified threshold value (requests / sec) |
| bdb_ram_dataset_overhead | [bdb_alert_settings_with_threshold]() object | Dataset RAM overhead of a shard has reached the threshold value (% of its RAM limit) |
| bdb_ram_values | [bdb_alert_settings_with_threshold]() object | Percent of values kept in a shard's RAM is lower than (% of its key count) |
| bdb_replica_src_high_syncer_lag | [bdb_alert_settings_with_threshold]() object | Replica of source sync lag is higher than specified threshold value (seconds) |
| bdb_replica_src_syncer_connection_error | [bdb_alert_settings_with_threshold]() object | Replica of source sync has connection error while trying to connect replica source |
| bdb_replica_src_syncer_general_error | [bdb_alert_settings_with_threshold]() object | Replica of sync encountered in general error |
| bdb_shard_num_ram_values | [bdb_alert_settings_with_threshold]() object | Number of values kept in a shard's RAM is lower than (values) |
| bdb_size | [bdb_alert_settings_with_threshold]() object | Dataset size has reached the threshold value \(% of the memory limit) |
| bdb_syncer_connection_error | [bdb_alert_settings_with_threshold]() object | Replica of sync has connection error while trying to connect replica source (deprecated as of Redis Software v5.0.1) |
| bdb_syncer_general_error | [bdb_alert_settings_with_threshold]() object | Replica of sync encountered in general error (deprecated as of Redis Software v5.0.1) |


title: Redis Software REST API objects

summary: Documents the objects used with Redis Software REST API calls.

summary: An object that represents cluster actions

title: Action object

summary: An object that contains alert info

title: Alert object

summary: An object that represents a database

title: BDB object

summary: An object that represents a group of databases with a shared memory pool

title: BDB group object

summary: An object for bootstrap configuration

title: Bootstrap object

summary: An object that represents a certificate

title: Certificates object

title: Check result object

summary: An object that represents a cluster

title: Cluster object

title: Cluster settings object

title: Cluster Manager settings object

summary: An object that represents an Active-Active database

title: CRDB object

summary: An object that represents a CRDB task

title: CRDB task object

title: Database alerts settings object

summary: An object for job scheduler settings

title: Job scheduler object

summary: An object for user authentication or a JW token refresh request

title: JWT authorize object

summary: An object that contains the cluster's LDAP configuration

title: LDAP object

summary: An object that represents a mapping between an LDAP group and roles

title: LDAP mapping object

summary: An object that represents a Redis module

title: Module object

summary: An object that represents Redis module metadata

title: Module metadata object

summary: An object that represents a node in the cluster

title: Node object

summary: An object that represents the cluster's OCSP configuration

title: OCSP object

summary: An object that represents the cluster's OCSP status

title: OCSP status object

summary: An object that represents a proxy in the cluster

title: Proxy object

summary: An object that represents a Redis access control list (ACL)

title: Redis ACL object

summary: An object that represents a role

title: Role object

summary: An object for optional cluster services settings

title: Services configuration object

summary: An object that represents a database shard

title: Shard object

summary: An object for single sign-on (SSO) configuration

title: SSO object

summary: An object that represents a state machine.

title: State machine object

summary: An object that contains metrics for clusters, databases, nodes, or shards

title: Statistics

summary: An object that represents a DNS suffix

title: Suffix object

summary: An API object that represents a Redis Software user

title: User object

title: Content

text:
Certain [REST API requests]() require you to include specific objects in the request body. Many requests also return objects in the response body.

Both REST API requests and responses represent these objects as [JSON](https://www.json.org).


title: Backup job settings object

summary: Documents the backup_job_settings object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the backup schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |


title: BDB usage report job settings object

summary: Documents the bdb_usage_report_job_settings object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the database usage report schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |
| file_retention_days | integer, 1-1000 (default: 365) | Number of days after a file is closed before it is deleted |


title: Certificate rotation job settings object

summary: Documents the cert_rotation_job_settings object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression              | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the certificate rotation schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |
| expiry_days_before_rotation  | integer, (range: 1-90) (default: 60) | Number of days before a certificate expires before rotation |


title: Job scheduler object

summary: An object for job scheduler settings

title: Backup job settings object

title: BDB usage report job settings object

summary: Documents the log_rotation_job_settings object used with Redis Software REST API calls.

title: Log rotation job settings object

summary: Documents the node_checks_job_settings object used with Redis Software REST API calls.

title: Node checks job settings object

summary: Documents the redis_cleanup_job_settings object used with Redis Software REST API calls.

title: Redis cleanup job settings object

summary: Documents the rotate_ccs_job_settings object used with Redis Software REST API calls.

title: Rotate CCS job settings object

title: Content

text:
An API object that represents the job scheduler settings in the cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| backup_job_settings | [backup_job_settings]() object | Backup job settings |
| bdb_usage_report_job_settings | [bdb_usage_report_job_settings]() object | Job settings for database usage reports |
| cert_rotation_job_settings | [cert_rotation_job_settings]() object | Job settings for internal certificate rotation |
| log_rotation_job_settings | [log_rotation_job_settings]() object | Log rotation job settings |
| node_checks_job_settings | [node_checks_job_settings]() object | Node checks job settings |
| redis_cleanup_job_settings | [redis_cleanup_job_settings]() object | Redis cleanup job settings (deprecated as of Redis Software v6.4.2, replaced with persistence_cleanup_scan_interval) |
| rotate_ccs_job_settings | [rotate_ccs_job_settings]() object | Rotate CCS job settings |


title: Log rotation job settings object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the log rotation schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |


title: Node checks job settings object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the node checks schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |


title: Redis cleanup job settings object

title: Content

text:
Deprecated and replaced with `persistence_cleanup_scan_interval`.

| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the Redis cleanup schedule |


title: Rotate CCS job settings object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| cron_expression | string | [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that defines the CCS rotation schedule |
| enabled | boolean (default: true) | Indicates whether this job is enabled |
| file_suffix | string (default: 5min) | String added to the end of the rotated RDB files |
| rotate_max_num | integer, (range: 1-100) (default: 24) | The maximum number of saved RDB files |


title: JWT authorize object

summary: An object for user authentication or a JW token refresh request

title: Content

text:
An API object for user authentication or a JW token refresh request.

| Name | Type/Value | Description |
|------|------------|-------------|
| password | string | The user’s password (required) |
| ttl | integer (range: 1-86400) (default: 300) | Time to live - The amount of time in seconds the token will be valid |
| username | string | The user’s username (required) |


title: LDAP object

summary: An object that contains the cluster's LDAP configuration

title: Content

text:
An API object that represents the cluster's [LDAP]() configuration.

| Name | Type/Value | Description |
|------|------------|-------------|
| bind_dn | string | DN used when binding with the LDAP server to run queries |
| bind_pass | string | Password used when binding with the LDAP server to run queries |
| ca_cert | string | PEM-encoded CA certificate(s) used to validate TLS connections to the LDAP server |
| cache_ttl | integer (default: 300) | Maximum TTL (in seconds) of cached entries |
| control_plane | boolean (default: false) | Use LDAP for user authentication/authorization in the control plane |
| data_plane | boolean (default: false) | Use LDAP for user authentication/authorization in the data plane |
| directory_timeout_s | integer (range: 5-60) (default: 5) | The connection timeout to the LDAP server when authenticating a user, in seconds |
| dn_group_attr | string | The name of an attribute of the LDAP user entity that contains a list of the groups that user belongs to. `dn_group_attr` is mutually exclusive with `dn_group_query`. |
| dn_group_query | complex object | An LDAP search query used to find a user’s groups, which determine the user’s level of access to the cluster and database as defined by Redis ACLs when [mapped to roles](). `dn_group_query` is mutually exclusive with `dn_group_attr`.

Contains the following fields:
**base**: Defines the starting point DN (unique identifier Distinguished Name) in the directory information tree for the search. Example value: `"DC=example,DC=com"`
**filter**: An [RFC-4515](https://www.rfc-editor.org/info/rfc4515) string representation of the search filter to apply. Defines the conditions required for an entry to appear in the search results. Example value: `"member=%D"` where `%D` is replaced with the user's DN.
**scope**: Defines the scope of the LDAP search according to the following values:
**"base"**: Search the base entry.
**"one"**: Search the base entry's immediate children.
**"subtree"**: Search the base entry and all its descendants. |
| starttls | boolean (default: false) | Use StartTLS negotiation for the LDAP connection |
| uris | array of strings | URIs of LDAP servers that only contain the schema, host, and port |
| user_dn_query | complex object | An LDAP search query used to find and authenticate LDAP users. `user_dn_query` is mutually exclusive with `user_dn_template`.

Contains the following fields:
**base**: Defines the starting point DN (unique identifier Distinguished Name) in the directory information tree for the search. Example value: `"DC=example,DC=com"`
**filter**: An [RFC-4515](https://www.rfc-editor.org/info/rfc4515) string representation of the search filter to apply. Defines the conditions required for an entry to appear in the search results. Example value: `"(&(objectClass=Person)(cn=%u))"` where `%u` is replaced with the username.
**scope**: Defines the scope of the LDAP search according to the following values:
**"base"**: Search the base entry.
**"one"**: Search the base entry's immediate children.
**"subtree"**: Search the base entry and all its descendants. |
| user_dn_template | string | A string template that maps between the username, provided to the cluster for authentication, and the LDAP DN. The substring "%u" will be replaced with the username. `user_dn_template` is mutually exclusive with `user_dn_query`. |


title: LDAP mapping object

summary: An object that represents a mapping between an LDAP group and roles

title: Content

text:
An API object that represents an [LDAP mapping]() between an LDAP group and [roles]().

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | LDAP mapping's unique ID |
| account_id | integer | SM account ID |
| action_uid | string | Action UID. If it exists, progress can be tracked by the `GET` `/actions/{uid}` API (read-only) |
| bdbs_email_alerts | complex object | UIDs of databases that associated email addresses will receive alerts for |
| cluster_email_alerts | boolean | Activate cluster email alerts for an associated email |
| dn | string | An LDAP group's distinguished name |
| email | string | Email address used for alerts (if set) |
| email_alerts | boolean (default: true) | Activate email alerts for an associated email |
| name | string | Role's name |
| role_uids | array of integers | List of role UIDs associated with the LDAP group |


title: Module object

summary: An object that represents a Redis module

title: Content

text:
Represents a [Redis module]().

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | string | Cluster unique ID of module |
| author | string | Module creator |
| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) |
| capabilities | array of strings | List of capabilities supported by this module |
| capability_name | string | Short description of module functionality |
| command_line_args | string | Command line arguments passed to the module |
| compatible_redis_version | string | Redis version required by this module |
| config_command | string | Name of command to configure module arguments at runtime |
| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**supported_featureset_versions**: array of integers |
| dependencies | dependencies object | Module dependencies |
| description | string | Short description of the module |
| display_name | string | Name of module for display purposes |
| email | string | Author's email address |
| homepage | string | Module's homepage |
| is_bundled | boolean | Whether module came bundled with a version of Redis Software |
| license | string | Module is distributed under this license |
| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |
| module_file | string | Module filename |
| module_name | string | Module's name
Values:
`search`
`ReJSON`
`timeseries`
`bf` |
| semantic_version | string | Module's semantic version |
| sha256 | string | SHA256 of module binary (deprecated) |
| version | integer | Module's version |


title: Module metadata object

summary: An object that represents Redis module metadata

title: Content

text:
Represents a [Redis module]().

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | string | Cluster unique ID of module |
| author | string | Module creator |
| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) |
| capabilities | array of strings | List of capabilities supported by this module |
| capability_name | string | Short description of module functionality |
| command_line_args | string | Command-line arguments passed to the module |
| compatible_redis_version | string | Redis version required by this module |
| config_command | string | Name of command to configure module arguments at runtime |
| crdb | CRDB object | CRDB-related information about the module
CRDB object fields:
**name**: string
**supported_featureset_versions**: array of integers |
| dependencies | dependencies object | Module dependencies |
| description | string | Short description of the module |
| display_name | string | Name of module for display purposes |
| email | string | Author's email address |
| homepage | string | Module's homepage |
| license | string | Module is distributed under this license |
| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |
| module_file | string | Module filename |
| module_name | string | Module's name |
| semantic_version | string | Module's semantic version |
| sha256 | string | SHA256 of module binary |
| version | integer | Module's version |


title: Node object

summary: An object that represents a node in the cluster

title: Content

text:
An API object that represents a node in the cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Cluster unique ID of node (read-only) |
| accept_servers | boolean (default: true) | The node only accepts new shards if `accept_servers` is `true` |
| addr | string | Internal IP address of node |
| architecture | string | Hardware architecture (read-only) |
| bigredis_storage_path | string | Flash storage path (read-only) |
| bigstore_driver | 'ibm-capi-ga1'
'ibm-capi-ga2'
'ibm-capi-ga4'
'speedb'
'rocksdb' | Bigstore driver name or none (deprecated as of Redis Software v7.2, use the [cluster object]()'s `bigstore_driver` instead) |
| bigstore_enabled | boolean | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering]() databases. Configurable during [bootstrapping](). After bootstrapping, it is read-only. |
| bigstore_size | integer | Storage size of bigstore storage (read-only) |
| cores | integer | Total number of CPU cores (read-only) |
| ephemeral_storage_path | string | Ephemeral storage path (read-only) |
| ephemeral_storage_size | number | Ephemeral storage size (bytes) (read-only) |
| external_addr | complex object | External IP addresses of node. `GET` `/jsonschema` to retrieve the object's structure. |
| max_listeners | integer | Maximum number of listeners on the node |
| max_redis_forks | integer (default: -1) | Maximum number of background processes forked from shards that can exist on the node at any given time. Set to 0 for unlimited. Set to -1 to use cluster settings. |
| max_redis_servers | integer | Maximum number of shards on the node |
| max_slave_full_syncs | integer (default: -1) | Maximum number of simultaneous replica full syncs that can run at any given time. Set to 0 for unlimited. Set to -1 to use cluster settings. |
| os_family | 'rhel'
'ubuntu'
'amzn' | Operating system family (read-only) |
| os_name | string | Operating system name (read-only) |
| os_semantic_version | string | Full version number (read-only) |
| os_version | string | Installed OS version (human-readable) (read-only) |
| persistent_storage_path | string | Persistent storage path (read-only) |
| persistent_storage_size | number | Persistent storage size (bytes) (read- only) |
| public_addr | string | Public IP address of node (deprecated as of Redis Software v4.3.3, use external_addr instead) |
| rack_id | string | Rack ID where node is installed |
| recovery_path | string | Recovery files path |
| second_rack_id | string | Second rack ID where node is installed |
| shard_count | integer | Number of shards on the node (read-only) |
| shard_list | array of integers | Cluster unique IDs of all node shards |
| software_version | string | Installed Redis Software cluster software version (read-only) |
| status | 'active'
'decommissioning'
'down'
'provisioning' | Node status (read-only) |
| supported_database_versions |
[{
  "db_type": string,
  "version": string
}, ...]
 | Versions of Redis Open Source databases supported by Redis Software on the node (read-only)
**db_type**: Type of database
**version**: Version of database |
| system_time | string | System time (UTC) (read-only) |
| total_memory | integer | Total memory of node (bytes) (read-only) |
| uptime | integer | System uptime (seconds) (read-only) |
| use_internal_ipv6 | boolean (default: false) | Node uses IPv6 for internal communication. Value is taken from bootstrap identity (read-only) |


title: OCSP object

summary: An object that represents the cluster's OCSP configuration

title: Content

text:
An API object that represents the cluster's OCSP configuration.

| Name | Type/Value | Description |
|------|------------|-------------|
| ocsp_functionality | boolean (default: false) | Enables or turns off OCSP for the cluster |
| query_frequency | integer <nobr>(range: 60-86400)</nobr> (default: 3600) | The time interval in seconds between OCSP queries to check the certificate’s status |
| recovery_frequency | integer <nobr>(range: 60-86400)</nobr> (default: 60) | The time interval in seconds between retries after the OCSP responder returns an invalid status for the certificate |
| recovery_max_tries | integer <nobr>(range: 1-100)</nobr> (default: 5) | The number of retries before the validation query fails and invalidates the certificate |
| responder_url | string | The OCSP server URL embedded in the proxy certificate (if available) (read-only) |
| response_timeout | integer <nobr>(range: 1-60)</nobr> (default: 1) | The time interval in seconds to wait for a response before timing out |


title: OCSP status object

summary: An object that represents the cluster's OCSP status

title: Content

text:
An API object that represents the cluster's OCSP status.

| Name | Type/Value | Description |
|------|------------|-------------|
| cert_status | string | Indicates the proxy certificate's status: GOOD/REVOKED/UNKNOWN (read-only) |
| responder_url | string | The OCSP responder URL this status came from (read-only) |
| next_update | string | The expected date and time of the next certificate status update (read-only) |
| produced_at | string | The date and time when the OCSP responder signed this response (read-only) |
| revocation_time | string | The date and time when the certificate was revoked or placed on hold (read-only) |
| this_update | string | The most recent time that the responder confirmed the current status (read-only) |


title: Proxy object

summary: An object that represents a proxy in the cluster

title: Content

text:
An API object that represents a [proxy](https://en.wikipedia.org/wiki/Proxy_server) in the cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Unique ID of the proxy (read-only) |
| backlog | integer | TCP listen queue backlog |
| client_eviction | boolean (default: false) | If `true,`, enables client eviction based on `maxmemory_clients`. |
| client_keepcnt | integer | Client TCP keepalive count |
| client_keepidle | integer | Client TCP keepalive idle |
| client_keepintvl | integer | Client TCP keepalive interval |
| conns | integer | Number of connections |
| duration_usage_threshold | integer, <nobr>(range: 10-300)</nobr> | Max number of threads |
| dynamic_threads_scaling | boolean | Automatically adjust the number of threads|
| ignore_bdb_cconn_limit | boolean | Ignore client connection limits |
| ignore_bdb_cconn_output_buff_limits | boolean | Ignore buffer limit |
| incoming_connections_capacity | integer (default: 0) | The maximum number of concurrent incoming connections, also known as the maximum burst size. The default is 0, which means no limit. |
| incoming_connections_min_capacity | integer (default: 10) | The minimum number of free slots required before accepting new connections after an overflow. |
| incoming_connections_rate_limit | integer (default: 0) | The maximum number of incoming connections per second. The default is 0, which means no limit. |
| log_level | `crit`
`error`
`warn`
`info`
`trace`
`debug` | Minimum log level to log. Only logs with this level or greater will be logged. |
| max_listeners | integer | Max number of listeners |
| max_servers | integer | Max number of Redis servers |
| max_threads | integer, <nobr>(range: 1-256)</nobr> | Max number of threads |
| max_worker_client_conns | integer | Max client connections per thread |
| max_worker_server_conns | integer | Max server connections per thread |
| max_worker_txns | integer | Max in-flight transactions per thread |
| maxmemory_clients | integer (default: 4294967296) | Maximum total memory, in bytes, used by clients |
| threads | integer, <nobr>(range: 1-256)</nobr> | Number of threads |
| threads_usage_threshold | integer, <nobr>(range: 50-99)</nobr> | Max number of threads |


title: Redis ACL object

summary: An object that represents a Redis access control list (ACL)

title: Content

text:
An API object that represents a Redis [access control list (ACL)]()

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Object's unique ID |
| account_id | integer | SM account ID |
| acl | string | Redis ACL's string |
| action_uid | string | Action UID. If it exists, progress can be tracked by the `GET` `/actions/{uid}` API (read-only) |
| name | string | Redis ACL's name |
| min_version | string | Minimum database version that supports this ACL. Read only |
| max_version | string | Maximum database version that supports this ACL. Read only |


title: Role object

summary: An object that represents a role

title: Content

text:
An API object that represents a role.

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | integer | Role's unique ID |
| account_id | integer | SM account ID |
| action_uid | string | Action UID. If it exists, progress can be tracked by the GET /actions/{uid} API (read-only) |
| management | 'admin'
'db_member'
'db_viewer'
'cluster_member'
'cluster_viewer'
'user_manager'
'none' | [Management role]() |
| name | string | Role's name |


title: Alert manager object

summary: Documents the alert_mgr object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the alert manager processes |


title: Call home agent object

summary: Documents the call_home_agent object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the call_home_agent process, which sends daily usage statistics to Redis |


title: CM server object

summary: Documents the cm_server object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the CM server |


title: CRDB coordinator object

summary: Documents the crdb_coordinator object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the CRDB coordinator process |


title: CRDB worker object

summary: Documents the crdb_worker object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the CRDB worker processes |


title: Entra ID agent manager object

summary: Documents the entraid_agent_mgr object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the Entra ID agent manager processes |


title: Services configuration object

summary: An object for optional cluster services settings

title: Alert manager object

title: Call home agent object

title: CM server object

title: CRDB coordinator object

title: CRDB worker object

title: Entra ID agent manager object

summary: Documents the ldap_agent_mgr object used with Redis Software REST API calls.

title: LDAP agent manager object

summary: Documents the mdns_server object used with Redis Software REST API calls.

title: MDNS server object

summary: Documents the pdns_server object used with Redis Software REST API calls.

title: PDNS server object

summary: Documents the sentinel_service object used with Redis Software REST API calls.

title: Sentinel service object

summary: Documents the stats_archiver object used with Redis Software REST API calls.

title: Stats archiver object

title: Content

text:
Optional cluster services settings

| Name | Type/Value | Description |
|------|------------|-------------|
| alert_mgr | [alert_mgr]() object | Whether to enable/disable the alert manager processes |
| call_home_agent | [call_home_agent]() object | Whether to enable/disable the call_home_agent process, which sends daily usage statistics to Redis |
| cm_server | [cm_server]() object | Whether to enable/disable the CM server |
| crdb_coordinator | [crdb_coordinator]() object | Whether to enable/disable the CRDB coordinator process |
| crdb_worker | [crdb_worker]() object | Whether to enable/disable the CRDB worker processes |
| entraid_agent_mgr | [entraid_agent_mgr]() object | Whether to enable/disable the Entra ID agent manager process |
| ldap_agent_mgr | [ldap_agent_mgr]() object | Whether to enable/disable the LDAP agent manager processes |
| mdns_server | [mdns_server]() object | Whether to enable/disable the multicast DNS server |
| pdns_server | [pdns_server]() object | Whether to enable/disable the PDNS server |
| sentinel_service | [sentinel_service]() object | Whether to enable/disable the Sentinel service process |
| stats_archiver | [stats_archiver]() object | Whether to enable/disable the stats archiver service |


title: LDAP agent manager object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the LDAP agent manager processes |


title: MDNS server object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the multicast DNS server |


title: PDNS server object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the PDNS server |


title: Sentinel service object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the Sentinel service process |


title: Stats archiver object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| operating_mode | 'disabled'<br />'enabled' | Enable/disable the stats archiver service |


title: Backup object

summary: Documents the backup object used with Redis Software REST API calls.

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| progress  | number, (range: 0-100) | Shard backup progress (percentage) |
| status    | 'exporting'
'succeeded'
'failed' | Status of scheduled periodic backup process |


title: Shard object

summary: An object that represents a database shard

title: Backup object

summary: Documents the loading object used with Redis Software REST API calls.

title: Loading object

summary: Documents the sync object used with Redis Software REST API calls.

title: Sync object

title: Content

text:
An API object that represents a Redis shard in a database.

| Name | Type/Value | Description |
|------|------------|-------------|
| uid | string | Cluster unique ID of shard |
| assigned_slots | string | Shards hash slot range |
| backup | [backup]() object | Current status of scheduled periodic backup process |
| bdb_uid | integer | The ID of the database this shard belongs to |
| bigstore_ram_weight | number | Shards RAM distribution weight |
| detailed_status | 'busy'
'down'
'importing'
'loading'
'ok'
'timeout'
'trimming'
'unknown' | A more detailed status of the shard |
| loading | [loading]() object | Current status of dump file loading |
| node_uid | string | The ID of the node this shard is located on |
| redis_info | redis_info object | A sub-dictionary of the [Redis INFO command]() |
| report_timestamp | string | The time in which the shard's info was collected (read-only) |
| role | 'master'
'slave' | Role of this shard |
| status | 'active'
'inactive'
'trimming' | The current status of the shard |
| sync | [sync]() object | Shard's current sync status and progress |


title: Loading object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| progress  | number, (range: 0-100) | Percentage of bytes already loaded |
| status    | 'in_progress'<br />'idle' | Status of the load of a dump file (read-only) |


title: Sync object

title: Content

text:
| Name | Type/Value | Description |
|------|------------|-------------|
| progress  | integer        | Number of bytes remaining in current sync |
| status    | 'in_progress'
'idle'
'link_down' | Indication of the shard's current sync status |


title: SSO object

summary: An object for single sign-on (SSO) configuration

title: Content

text:
An API object that represents single sign-on (SSO) configuration in the cluster.

| Name | Type/Value | Description |
|------|------------|-------------|
| control_plane | boolean (default: false) | If `true`, enables single sign-on (SSO) for the control plane. |
| enforce_control_plane | boolean (default: false) | If `true`, enforce SSO login for the control plane for non-admin users. If `false`, all users can still login using their local username and password if SSO is down. |
| protocol | "saml2" | SSO protocol to use. |
| issuer | complex object	 | Issuer related configuration.
Contains the following fields:
**id**: Unique ID of the issuer side (example: "urn:sso:example:idp")
**login_url**: SSO login URL (example: "https://idp.example.com/sso/saml")
**logout_url**: SSO logout URL (example: "https://idp.example.com/sso/slo")
**metadata**: Base64 encoded IdP metadata (read-only) |
| service | complex object	 | Service related configuration.
For SAML2 service configuration:
{
  "address": "string",
  "saml2": {
    "entity_id": "string",
    "acs_url": "string",
    "slo_url": "string"
  }
}
**address**: External service address used for SSO. By default, the cluster name with the Cluster Manager port is used.
**acs_url**: Assertion Consumer Service URL (read-only)
**slo_url**: Single Logout URL (read-only)
**entity_id**: Service entity ID (read-only) |