Back to Redis

Module Capabilities

content/operate/rs/7.22/references/rest-api/requests/cluster/module-capabilities.md

latest1.3 KB
Original Source
MethodPathDescription
GET/v1/cluster/module-capabilitiesList possible Redis module capabilities

List Redis module capabilities {#get-cluster-module-capabilities}

GET /v1/cluster/module-capabilities

List possible Redis module capabilities.

Required permissions

Permission name
[view_cluster_modules]({{< relref "/operate/rs/7.22/references/rest-api/permissions#view_cluster_modules" >}})

Request {#get-request}

Example HTTP request

GET /v1/cluster/module-capabilities 

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Accept*/*Accepted media type

Response {#get-response}

Returns a JSON object that contains a list of capability names and descriptions.

Example JSON body

json
{
  "all_capabilities": [
    {"name": "types", "desc": "module has its own types and not only operate on existing redis types"},
    {"name": "no_multi_key", "desc": "module has no methods that operate on multiple keys"}
    "// additional capabilities..."
  ]
}

Status codes {#get-status-codes}

CodeDescription
200 OKNo error