A REST API request requires the following components:

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

Some requests may also require:

RequestDescription
actionsActions requests
bdbsDatabase requests
bootstrapBootstrap requests
clusterCluster settings requests
crdb_tasksActive-Active database task status requests
crdbsActive-Active database requests
debuginfoDebug info requests
endpoints/statsEndpoint statistics requests
jsonschemaAPI object JSON schema requests
ldap_mappingsLDAP mappings requests
licenseLicense requests
logsCluster event logs requests
modulesRedis modules requests
nodesNode requests
ocspOCSP requests
proxiesProxy requests
redis_aclsRedis access control list (ACL) requests
rolesRoles requests
shards/statsShard statistics requests
suffixDNS suffix requests
suffixesDNS suffixes requests
usersUser requests