Back to Redis

Module Metadata

content/operate/rs/7.8/references/rest-api/objects/module_metadata.md

latest1.7 KB
Original Source

Represents a [Redis module]({{< relref "/operate/oss_and_stack/stack-with-enterprise" >}}).

NameType/ValueDescription
uidstringCluster unique ID of module
architecturestringModule was compiled under this architecture
authorstringModule creator
capabilitiesarray of stringsList of capabilities supported by this module
capability_namestringShort description of module functionality
command_line_argsstringCommand-line arguments passed to the module
compatible_redis_versionstringRedis version required by this module
config_commandstringName of command to configure module arguments at runtime
crdbCRDB objectCRDB-related information about the module
CRDB object fields:
name: string
supported_featureset_versions: array of integers
dependenciesdependencies objectModule dependencies
descriptionstringShort description of the module
display_namestringName of module for display purposes
emailstringAuthor's email address
homepagestringModule's homepage
licensestringModule is distributed under this license
min_redis_pack_versionstringMinimum Redis Enterprise Software cluster version required by this module
min_redis_versionstringMinimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4.
module_filestringModule filename
module_namestringModule's name
semantic_versionstringModule's semantic version
sha256stringSHA256 of module binary
versionintegerModule's version