Modules requests
Redis modules requests
| Redis Enterprise Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/modules |
List available modules |
| GET | /v1/modules/{uid} |
Get a specific module |
List modules
GET /v1/modules
List available modules, i.e. modules stored within the CCS.
Permissions
| Permission name | Roles |
|---|---|
| view_cluster_modules | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /v1/modules
Headers
| Key | Value | Description |
|---|---|---|
| Host | 127.0.0.1:9443 | Domain name |
| Accept | */* | Accepted media type |
Response
Returns a JSON array of module objects.
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |
Get module
GET /v1/modules/{string: uid}
Get specific available modules, i.e. modules stored within the CCS.
Permissions
| Permission name | Roles |
|---|---|
| view_cluster_modules | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /v1/modules/1
Headers
| Key | Value | Description |
|---|---|---|
| Host | 127.0.0.1:9443 | Domain name |
| Accept | */* | Accepted media type |
URL parameters
| Field | Type | Description |
|---|---|---|
| uid | integer | The module's unique ID. |
Response
Returns a module object.
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |
| 404 Not Found | Module does not exist. |