{
  "id": "cm_settings",
  "title": "Cluster Manager settings requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cm_settings/",
  "summary": "REST API requests for Cluster Manager UI settings",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-cm-settings) | `/v1/cm_settings` | Get Cluster Manager UI settings |\n| [PUT](#put-cm-settings) | `/v1/cm_settings` | Update Cluster Manager UI settings |\n\n## Get CM settings {#get-cm-settings}\n\n```sh\nGET /v1/cm_settings\n```\n\nGet Cluster Manager UI settings.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_cluster_info]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/cm_settings\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response}\n\nReturns a [cm_settings object]().\n\n#### Example JSON body\n\n```json\n{\n    \"timezone\": \"UTC\"\n}\n```\n\n#### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | No error |\n\n## Update CM settings {#put-cm-settings}\n\n```sh\nPUT /v1/cm_settings\n```\n\nUpdate Cluster Manager UI settings.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [update_cluster]() | admin |\n\n### Request {#put-request}\n\n#### Example HTTP request\n\n```sh\nPUT /v1/cm_settings\n```\n\n#### Example JSON body\n\n```json\n{\n    \"timezone\": \"US/Pacific\"\n}\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Body\n\nInclude a [cm_settings object]() with updated fields in the request body.\n\n### Response {#put-response}\n\nReturns a [cm_settings object]() with the updated fields.\n\n#### Example JSON body\n\n```json\n{\n    \"timezone\": \"US/Pacific\"\n}\n```\n\n#### Status codes {#put-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok) | Success, time zone config has been set. |\n| [400 Bad Request](https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request) | Bad or missing configuration parameters. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": []
}

