{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/module",
  "title": "Module object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/module/",
  "summary": "An object that represents a Redis module",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-01-30T12:29:26-06:00",
  "page_type": "content",
  "content_hash": "9f95dfdbfae2286c55f560834a44850d600b3356f0b0f7c3686878a58c9fa52b",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "Represents a [Redis module](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise).\n\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| uid | string | Cluster unique ID of module |\n| author | string | Module creator |\n| bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) |\n| capabilities | array of strings | List of capabilities supported by this module |\n| capability_name | string | Short description of module functionality |\n| command_line_args | string | Command line arguments passed to the module |\n| compatible_redis_version | string | Redis version required by this module |\n| config_command | string | Name of command to configure module arguments at runtime |\n| crdb | CRDB object | CRDB-related information about the module<br />CRDB object fields:<br />**supported_featureset_versions**: array of integers |\n| dependencies | dependencies object | Module dependencies |\n| description | string | Short description of the module |\n| display_name | string | Name of module for display purposes |\n| email | string | Author's email address |\n| homepage | string | Module's homepage |\n| is_bundled | boolean | Whether module came bundled with a version of Redis Software |\n| license | string | Module is distributed under this license |\n| min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |\n| module_file | string | Module filename |\n| module_name | string | Module's name<br />Values:<br />`search`<br />`ReJSON`<br />`timeseries`<br />`bf` |\n| semantic_version | string | Module's semantic version |\n| sha256 | string | SHA256 of module binary (deprecated) |\n| version | integer | Module's version |"
    }
  ],
  "examples": []
}