A REST API request requires the following components:

  • HTTP method (GET, PUT, PATCH, POST, DELETE)
  • Base URL
  • Endpoint

Some requests may also require:

Request Description
actions Actions requests
bdbs Database requests
bootstrap Bootstrap requests
cluster Cluster settings requests
crdb_tasks Active-Active database task status requests
crdbs Active-Active database requests
debuginfo Debug info requests
endpoints/stats Endpoint statistics requests
jsonschema API object JSON schema requests
ldap_mappings LDAP mappings requests
license License requests
logs Cluster event logs requests
modules Redis modules requests
nodes Node requests
ocsp OCSP requests
proxies Proxy requests
redis_acls Redis access control list (ACL) requests
roles Roles requests
shards/stats Shard statistics requests
suffix DNS suffix requests
suffixes DNS suffixes requests
users User requests