{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests",
  "title": "Redis Software REST API requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/",
  "summary": "Documents the requests supported by the Redis Software REST API calls.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-01-30T12:29:26-06:00",
  "children": [
    {
      "id": "operate/rs/references/rest-api/requests/actions",
      "summary": "Actions requests",
      "title": "Actions requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/actions/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/bdbs",
      "summary": "Database requests",
      "title": "Database requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/bootstrap",
      "summary": "Bootstrap requests",
      "title": "Bootstrap requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bootstrap/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/cluster",
      "summary": "Cluster settings requests",
      "title": "Cluster requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/cm_settings",
      "summary": "REST API requests for Cluster Manager UI settings",
      "title": "Cluster Manager settings requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cm_settings/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/crdb_tasks",
      "summary": "Active-Active database task status requests",
      "title": "CRDB tasks requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/crdb_tasks/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/crdbs",
      "summary": "Active-Active database requests",
      "title": "CRDBs requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/crdbs/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/debuginfo",
      "summary": "Debug info requests",
      "title": "Debug info requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/debuginfo/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/diagnostics",
      "summary": "REST API requests for the diagnostic logging service.",
      "title": "Diagnostics requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/diagnostics/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/endpoints-stats",
      "summary": "Endpoint statistics requests",
      "title": "Endpoints stats requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/endpoints-stats/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/job_scheduler",
      "summary": "REST API requests for the job scheduler",
      "title": "Job scheduler requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/job_scheduler/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/jsonschema",
      "summary": "API object JSON schema requests",
      "title": "JSON schema requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/jsonschema/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/ldap_mappings",
      "summary": "LDAP mappings requests",
      "title": "LDAP mappings requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ldap_mappings/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/license",
      "summary": "License requests",
      "title": "License requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/license/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/logs",
      "summary": "Cluster event logs requests",
      "title": "Logs requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/logs/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/metrics",
      "summary": "Local metrics storage requests",
      "title": "Metrics requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/metrics/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/metrics_config",
      "summary": "Metrics configuration requests",
      "title": "Metrics configuration requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/metrics_config/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/migrations",
      "summary": "REST API request to get the migration status of a database in the cluster when using Replica Of.",
      "title": "Migrations requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/migrations/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/modules",
      "summary": "Redis modules requests",
      "title": "Modules requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/node_master_healthcheck",
      "summary": "REST API requests to check a node's connection to the cluster's primary node.",
      "title": "Node master healthcheck requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/node_master_healthcheck/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/nodes",
      "summary": "Node requests",
      "title": "Nodes requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/ocsp",
      "summary": "OCSP requests",
      "title": "OCSP requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ocsp/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/proxies",
      "summary": "Proxy requests",
      "title": "Proxy requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/proxies/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/redis_acls",
      "summary": "Redis access control list (ACL) requests",
      "title": "Redis access control list (ACL) requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/redis_acls/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/roles",
      "summary": "Roles requests",
      "title": "Roles requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/roles/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/services",
      "summary": "REST API requests to list or modify Redis Software services.",
      "title": "Services requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/services/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/shards",
      "summary": "REST API requests for database shards",
      "title": "Shard requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/shards/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/suffix",
      "summary": "DNS suffix requests",
      "title": "Suffix requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/suffix/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/suffixes",
      "summary": "DNS suffixes requests",
      "title": "Suffixes requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/suffixes/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/usage_report",
      "summary": "REST API request to get the database usage report from the cluster.",
      "title": "Usage report requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/usage_report/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/users",
      "summary": "User requests",
      "title": "Users requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/users/"
    }
  ],
  "page_type": "content",
  "content_hash": "4fcb49a54af5930e3fc75bc8a7c0f6e343e1b106caf3d84fbeb0641ef474a2d9",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "A REST API request requires the following components:\n- [HTTP method](https://restfulapi.net/http-methods/) (`GET`, `PUT`, `PATCH`, `POST`, `DELETE`)\n- Base URL\n- Endpoint\n\nSome requests may also require:\n- URL parameters\n- [Query parameters](https://en.wikipedia.org/wiki/Query_string)\n- [JSON](http://www.json.org) request body\n- [Permissions](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions)\n\n\n| Request | Description |\n| --- | --- |\n| [actions](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/actions/) | Actions requests |\n| [bdbs](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs/) | Database requests |\n| [bootstrap](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bootstrap/) | Bootstrap requests |\n| [cluster](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cluster/) | Cluster settings requests |\n| [cm_settings](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cm_settings/) | REST API requests for Cluster Manager UI settings |\n| [crdb_tasks](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/crdb_tasks/) | Active-Active database task status requests |\n| [crdbs](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/crdbs/) | Active-Active database requests |\n| [debuginfo](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/debuginfo/) | Debug info requests |\n| [diagnostics](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/diagnostics/) | REST API requests for the diagnostic logging service. |\n| [endpoints/stats](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/endpoints-stats/) | Endpoint statistics requests |\n| [job_scheduler](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/job_scheduler/) | REST API requests for the job scheduler |\n| [jsonschema](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/jsonschema/) | API object JSON schema requests |\n| [ldap_mappings](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ldap_mappings/) | LDAP mappings requests |\n| [license](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/license/) | License requests |\n| [logs](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/logs/) | Cluster event logs requests |\n| [metrics](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/metrics/) | Local metrics storage requests |\n| [metrics_config](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/metrics_config/) | Metrics configuration requests |\n| [migrations](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/migrations/) | REST API request to get the migration status of a database in the cluster when using Replica Of. |\n| [modules](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules/) | Redis modules requests |\n| [node/master_healthcheck](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/node_master_healthcheck/) | REST API requests to check a node's connection to the cluster's primary node. |\n| [nodes](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/) | Node requests |\n| [ocsp](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ocsp/) | OCSP requests |\n| [proxies](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/proxies/) | Proxy requests |\n| [redis_acls](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/redis_acls/) | Redis access control list (ACL) requests |\n| [roles](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/roles/) | Roles requests |\n| [services](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/services/) | REST API requests to list or modify Redis Software services. |\n| [shards](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/shards/) | REST API requests for database shards |\n| [suffix](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/suffix/) | DNS suffix requests |\n| [suffixes](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/suffixes/) | DNS suffixes requests |\n| [usage_report](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/usage_report/) | REST API request to get the database usage report from the cluster. |\n| [users](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/users/) | User requests |"
    }
  ],
  "examples": []
}