{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/instance-settings",
  "title": "RDI instance settings",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/instance-settings/",
  "summary": "Change the settings of an RDI instance while it runs",
  "tags": [
    "docs",
    "integrate",
    "rs",
    "rdi"
  ],
  "last_updated": "2026-10-30T12:23:39+02:00",
  "page_type": "content",
  "content_hash": "a6f2e97f259f9fd247a0106e98cb6fd92eff90897a3783598c4e5864b868e78a",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Instance settings control the behavior of a single RDI instance. You can change them while RDI\nruns, without a Helm upgrade or a reinstallation, and changing them does not restart the RDI\noperator or the RDI API. A setting that you set overrides the corresponding installation value\nuntil you delete it.\n\nEach instance has its own settings, even when two instances share the same RDI database in a\n[high availability](https://redis.io/docs/latest/integrate/redis-data-integration/installation/install-vm#installing-with-high-availability)\nsetup. Run the commands, or send the API requests, to the instance that you want to change."
    },
    {
      "id": "manage-instance-settings",
      "title": "Manage instance settings",
      "role": "content",
      "text": "Use the following CLI commands to manage the settings of an instance:\n\n[code example]\n\nThe CLI shows a setting that is not set as `<none>`. See\n[`list-settings`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-list-settings),\n[`get-setting`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-get-setting),\n[`set-setting`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-set-setting), and\n[`delete-setting`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-delete-setting)\nfor the command options.\n\nWith RDI API v2, `GET /api/v2/settings` returns all the settings of the instance, with `null` for\na setting that is not set. `PATCH /api/v2/settings` applies its body as a JSON merge patch: a\nvalue sets a setting, `null` deletes it, and the settings that the body omits are unchanged. For\nexample, the following body sets `standby_mode`:\n\n[code example]"
    },
    {
      "id": "available-settings",
      "title": "Available settings",
      "role": "content",
      "text": "| Setting | Type | When not set |\n| :-- | :-- | :-- |\n| [`standby_mode`](#standby_mode) | Boolean | The `operator.leaderElection.standbyMode` Helm value, `false` by default |"
    },
    {
      "id": "standby_mode",
      "title": "`standby_mode`",
      "role": "content",
      "text": "Controls whether the instance takes part in the leader election that decides which instance\nruns the pipelines. Use it to fail over to another instance deliberately, for example before\nmaintenance. See [Trigger a failover manually](https://redis.io/docs/latest/integrate/redis-data-integration/installation/ha-test#trigger-a-failover-manually)\nfor the steps.\n\n- `true`: The instance leaves the leader election. If it is the leader, it gives up the\n  leadership, so that another instance can take over. Its pipelines change to the `standby`\n  status, and RDI removes their collectors and stream processors from it.\n- `false`: The instance takes part in the leader election, even if `operator.leaderElection.standbyMode`\n  is `true` in its Helm values.\n- Not set: The `operator.leaderElection.standbyMode` Helm value applies.\n\nThe operator applies a change on its next leader election check, within 10 seconds with the\ndefault configuration. The setting has no effect while leader election is disabled."
    }
  ],
  "examples": [
    {
      "id": "manage-instance-settings-ex0",
      "language": "bash",
      "code": "# List all the settings and their values\nredis-di list-settings\n\n# Show the value of one setting\nredis-di get-setting standby_mode\n\n# Set a setting\nredis-di set-setting standby_mode true\n\n# Delete a setting, so that the installation value applies again\nredis-di delete-setting standby_mode",
      "section_id": "manage-instance-settings"
    },
    {
      "id": "manage-instance-settings-ex1",
      "language": "json",
      "code": "{\"standby_mode\": true}",
      "section_id": "manage-instance-settings"
    }
  ]
}