User Defined

List custom module artifacts {#get-local-user-defined-artifacts}

GET /v2/local/modules/user-defined/artifacts

Returns a list of all custom module artifacts on the local node.

Permissions

Request {#get-local-artifacts-request}

Example HTTP request

GET /v2/local/modules/user-defined/artifacts

Headers

Response {#get-local-artifacts-response}

Returns a JSON array of custom module artifacts.

Example JSON body

[
     {
         "module_name": "TestModule",
         "version": 123,
         "dependencies": [
             "dep_1",
             "dep_2"
         ]
     }
]

Status codes {#get-local-artifacts-status-codes}

Upload custom module configuration {#post-user-defined-module}

POST /v2/modules/user-defined

Creates a module object in the cluster configuration store (CCS). After calling this endpoint, you still need to upload the module's .zip file, which contains the .so and module.json files, to each node by calling POST /v2/local/modules/user-defined/artifacts on each node.

Permissions

Request {#post-user-defined-request}

Example HTTP request

POST /v2/modules/user-defined

Example JSON body

{
     "module_name": "TestModule",
     "version": 1,
     "semantic_version": "0.0.1",
     "display_name": "test module",
     "commands": [
         {
             "command_arity": -1,
             "command_name": "json.arrtrim",
             "first_key": 1,
             "flags": ["write"],
             "last_key": 1,
             "step": 1
         }
     ],
     "command_line_args": "",
     "capabilities": ["list", "of", "capabilities"],
     "min_redis_version": "2.1"
}

Headers

Request body

The request body is a JSON object that must contain the following fields:

Response {#post-user-defined-response}

Returns a [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}).

Example JSON body

{
    "author": "author name",
    "uid": "1952fcf9a5109fb59e61b1ad4d7e2d88"
    // additional fields...
}

Status codes {#post-user-defined-status-codes}

Upload custom module artifact to a node {#post-local-user-defined-artifacts}

POST /v2/local/modules/user-defined/artifacts

A local API to upload a custom module's artifact to the current node. You must call this API on each cluster node.

The module must be packaged as a .zip file containing:

• module.json: A metadata file with module information including:

  • module_name: The actual module name
  • version: Numeric version
  • semantic_version: Semantic version string (for example, "1.0.0")
  • min_redis_version: Minimum compatible Redis version
  • commands: List of commands the module provides
  • capabilities: List of module capabilities

• Module binary: The compiled .so file for the target platform

Permissions

Request {#post-local-artifacts-request}

Example HTTP request

POST /v2/local/modules/user-defined/artifacts

Headers

Response {#post-local-artifacts-response}

Returns a status code to indicate upload success or failure.

Status codes {#post-local-artifacts-status-codes}

Delete custom module {#delete-user-defined-module}

DELETE /v2/modules/user-defined/{string: uid}

Delete a module object from the cluster configuration store (CCS). This REST API request does not delete the module artifact from the nodes, so you also need to call DELETE /v2/local/modules/user-defined/artifacts/<module_name>/<version> on each node.

Permissions

Request {#delete-user-defined-request}

Example HTTP request

DELETE /v2/modules/user-defined/1

Headers

URL parameters

Response {#delete-user-defined-response}

Returns a status code to indicate module deletion success or failure.

Status codes {#delete-user-defined-status-codes}

Delete custom module artifact from a node{#delete-local-user-defined-artifacts}

DELETE /v2/local/modules/user-defined/artifacts/{string: module_name}/{int: version}

A local API to delete a custom module's artifact from the current node. You must call this API on each cluster node.

Permissions

Request {#delete-local-artifacts-request}

Example HTTP request

DELETE /v2/local/modules/user-defined/artifacts/some-custom-module/123

Headers

URL parameters

Response {#delete-local-artifacts-response}

Returns a status code to indicate deletion success or failure.

Status codes {#delete-local-artifacts-status-codes}