{
  "id": "modules",
  "title": "Modules requests",
  "url": "https://redis.io/docs/latest/operate/rs/8.0/references/rest-api/requests/modules/",
  "summary": "Redis modules requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#list-modules) | `/v1/modules` | List available modules |\n| [GET](#get-module) | `/v1/modules/{uid}` | Get a specific module |\n\n## List modules {#list-modules}\n\n```sh\nGET /v1/modules\n```\n\nList available modules, i.e. modules stored within the CCS.\n\n#### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_cluster_modules](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_cluster_modules) | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#list-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/modules\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | 127.0.0.1:9443 | Domain name |\n| Accept | \\*/\\* | Accepted media type |\n\n### Response {#list-response}\n\nReturns a JSON array of [module objects](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module).\n\n#### Status codes {#list-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n\n## Get module {#get-module}\n\n```sh\nGET /v1/modules/{string: uid}\n```\n\nGet specific available modules, i.e. modules stored within the CCS.\n\n#### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_cluster_modules](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_cluster_modules) | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/modules/1\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | 127.0.0.1:9443 | Domain name |\n| Accept | \\*/\\* | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| uid | integer | The module's unique ID. |\n\n### Response {#get-response}\n\nReturns a [module object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module).\n\n### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Module does not exist. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-07-23T12:05:56-05:00",
  "children": [{"id":"config","summary":"Configure module requests","title":"Configure module requests","url":"https://redis.io/docs/latest/operate/rs/8.0/references/rest-api/requests/modules/config/"},{"id":"user-defined","summary":"Custom, user-defined Redis module requests","title":"User-defined module requests","url":"https://redis.io/docs/latest/operate/rs/8.0/references/rest-api/requests/modules/user-defined/"}]
}
