{
  "id": "config",
  "title": "Database modules config requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/bdbs/modules/config/",
  "summary": "Configure Redis module requests",
  "content": "\n\nThis REST API path is deprecated as of Redis Enterprise Software version 7.4. Use [`PUT /v2/bdbs/\u003cuid\u003e`]() instead.\n\n\n| Method | Path | Description |\n|--------|------|-------------|\n| [POST](#post-bdb-modules-config) | `/v1/bdbs/{uid}/modules/config` | Configure module |\n\n## Configure module {#post-bdb-modules-config}\n\n\tPOST /v1/bdbs/{string: uid}/modules/config\n\nUse the module runtime configuration command (if defined) to configure new arguments for the module.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [edit_bdb_module]() |\n\n### Request {#post-request} \n\n#### Example HTTP request\n\n\tPOST /v1/bdbs/1/modules/config\n\n#### Example JSON body\n\n```json\n{\n  \"modules\": [\n    {\n      \"module_name\": \"search\",\n      \"module_args\": \"MINPREFIX 3 MAXEXPANSIONS 1000\"\n    }\n  ]\n}\n```\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Request body\n\n| Field | Type | Description |\n|-------|------|-------------|\n| modules | list of JSON objects | List of modules (module_name) and their new configuration settings (module_args) |\n| module_name | `search`\u003cbr /\u003e`ReJSON`\u003cbr /\u003e`graph`\u003cbr /\u003e`timeseries`\u003cbr /\u003e`bf` | Module's name |\n| module_args | string | Module command line arguments (pattern does not allow special characters \u0026,\u003c,\u003e,\") |\n\n### Response {#post-response} \n\nReturns a status code. If an error occurs, the response body may include an error code and message with more details.\n\n### Error codes {#post-error-codes} \n\nWhen errors are reported, the server may return a JSON object with `error_code` and `message` field that provide additional information. The following are possible `error_code` values:\n\n| Code | Description |\n|------|-------------|\n| db_not_exist | Database with given UID doesn't exist in cluster | \n| missing_field | \"module_name\" or \"module_args\" are not defined in request | \n| invalid_schema | JSON object received is not a dict object | \n| param_error | \"module_args\" parameter was not parsed properly | \n| module_not_exist | Module with given \"module_name\" does not exist for the database | \n\n### Status codes {#post-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, module updated on bdb. |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | bdb not found. |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing configuration parameters. |\n| [406 Not Acceptable](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7) | Module does not support runtime configuration of arguments. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}