{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/node",
  "title": "Node object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/node/",
  "summary": "An object that represents a node in the cluster",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-04-28T13:01:52-05:00",
  "page_type": "content",
  "content_hash": "fe25bd4fd67396f65a458988a29bb289b771a533972003fcbc9c000a46489134",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "An API object that represents a node in the cluster.\n\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| uid | integer | Cluster unique ID of node (read-only) |\n| accept_servers | boolean (default:&nbsp;true) | The node only accepts new shards if `accept_servers` is `true` |\n| addr | string | Internal IP address of node |\n| architecture | string | Hardware architecture (read-only) |\n| bigredis_storage_path | string | Flash storage path (read-only) |\n| bigstore_driver | 'ibm-capi-ga1'<br />'ibm-capi-ga2'<br />'ibm-capi-ga4'<br />'speedb'<br />'rocksdb' | Bigstore driver name or none (deprecated as of Redis Software v7.2, use the [cluster object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cluster)'s `bigstore_driver` instead) |\n| bigstore_enabled | boolean | If `true`, then flash storage is enabled on this node for [Redis Flex and Auto Tiering](https://redis.io/docs/latest/operate/rs/databases/flash) databases. Configurable during [bootstrapping](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bootstrap#post-bootstrap). After bootstrapping, it is read-only. |\n| bigstore_size | integer | Storage size of bigstore storage (read-only) |\n| cores | integer | Total number of CPU cores (read-only) |\n| ephemeral_storage_path | string | Ephemeral storage path (read-only) |\n| ephemeral_storage_size | number | Ephemeral storage size (bytes) (read-only) |\n| external_addr | complex object | External IP addresses of node. `GET`&nbsp;`/jsonschema` to retrieve the object's structure. |\n| max_listeners | integer | Maximum number of listeners on the node |\n| 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. |\n| max_redis_servers | integer | Maximum number of shards on the node |\n| 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. |\n| os_family | 'rhel'<br />'ubuntu'<br />'amzn' | Operating system family (read-only) |\n| os_name | string | Operating system name (read-only) |\n| os_semantic_version | string | Full version number (read-only) |\n| os_version | string | Installed OS version (human-readable) (read-only) |\n| oss_cluster_ip_mapping | [{<br />  \"key\": string,<br />  \"value\": object<br />}, ...] | Per-node OSS cluster IP mapping by client subnet/hostname.<br />**key**: Client subnet/hostname key. Can be ipv4/ipv6 CIDR, hostname, or 'default'. |\n| persistent_storage_path | string | Persistent storage path (read-only) |\n| persistent_storage_size | number | Persistent storage size (bytes) (read- only) |\n| public_addr | string | Public IP address of node (deprecated as of Redis Software v4.3.3, use external_addr instead) |\n| rack_id | string | Rack ID where node is installed |\n| recovery_path | string | Recovery files path |\n| second_rack_id | string | Second rack ID where node is installed |\n| shard_count | integer | Number of shards on the node (read-only) |\n| shard_list | array of integers | Cluster unique IDs of all node shards |\n| software_version | string | Installed Redis Software cluster software version (read-only) |\n| status | 'active'<br />'decommissioning'<br />'down'<br />'provisioning' | Node status (read-only) |\n| supported_database_versions | \n[{\n  \"db_type\": string,\n  \"version\": string\n}, ...]\n | Versions of Redis Open Source databases supported by Redis Software on the node (read-only)<br />**db_type**: Type of database<br />**version**: Version of database |\n| system_time | string | System time (UTC) (read-only) |\n| total_memory | integer | Total memory of node (bytes) (read-only) |\n| uptime | integer | System uptime (seconds) (read-only) |\n| use_internal_ipv6 | boolean (default:&nbsp;false) | Node uses IPv6 for internal communication. Value is taken from bootstrap identity (read-only) |"
    }
  ],
  "examples": []
}