{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests/modules",
  "title": "Modules requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules/",
  "summary": "Redis modules requests",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-10-30T12:00:21-05:00",
  "children": [
    {
      "id": "operate/rs/references/rest-api/requests/modules/config",
      "summary": "Configure module requests",
      "title": "Configure module requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules/config/"
    },
    {
      "id": "operate/rs/references/rest-api/requests/modules/user-defined",
      "summary": "Custom, user-defined Redis module requests",
      "title": "User-defined module requests",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules/user-defined/"
    }
  ],
  "page_type": "content",
  "content_hash": "e54a9e4fc0534c315f2e7cc936a1f691feb597305ec3c94889f15457a034cc8c",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#list-modules) | `/v1/modules` | List available modules |\n| [GET](#get-module) | `/v1/modules/{uid}` | Get a specific module |"
    },
    {
      "id": "list-modules",
      "title": "List modules",
      "role": "content",
      "text": "[code example]\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<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |"
    },
    {
      "id": "list-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n[code example]\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | 127.0.0.1:9443 | Domain name |\n| Accept | \\*/\\* | Accepted media type |"
    },
    {
      "id": "list-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns 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 |"
    },
    {
      "id": "get-module",
      "title": "Get module",
      "role": "content",
      "text": "[code example]\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<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |"
    },
    {
      "id": "get-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n[code example]\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. |"
    },
    {
      "id": "get-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a [module object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module)."
    },
    {
      "id": "get-status-codes",
      "title": "Status codes",
      "role": "content",
      "text": "| 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. |"
    }
  ],
  "examples": [
    {
      "id": "list-modules-ex0",
      "language": "sh",
      "code": "GET /v1/modules",
      "section_id": "list-modules"
    },
    {
      "id": "list-request-ex0",
      "language": "sh",
      "code": "GET /v1/modules",
      "section_id": "list-request"
    },
    {
      "id": "get-module-ex0",
      "language": "sh",
      "code": "GET /v1/modules/{string: uid}",
      "section_id": "get-module"
    },
    {
      "id": "get-request-ex0",
      "language": "sh",
      "code": "GET /v1/modules/1",
      "section_id": "get-request"
    }
  ]
}