{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/requests/cm_settings",
  "title": "Cluster Manager settings requests",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/requests/cm_settings/",
  "summary": "REST API requests for Cluster Manager UI settings",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2025-03-10T13:08:54-04:00",
  "children": [],
  "page_type": "content",
  "content_hash": "e34f00afca39116f664af3d470b7955b852b6f5c6181900d027c2dca340659c8",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "| 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 |"
    },
    {
      "id": "get-cm-settings",
      "title": "Get CM settings",
      "role": "content",
      "text": "[code example]\n\nGet Cluster Manager UI settings."
    },
    {
      "id": "permissions",
      "title": "Permissions",
      "role": "security",
      "text": "| Permission name | Roles |\n|-----------------|-------|\n| [view_cluster_info](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#view_cluster_info) | admin<br />cluster_member<br />cluster_viewer<br />db_member<br />db_viewer<br />user_manager |"
    },
    {
      "id": "get-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n[code example]\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |"
    },
    {
      "id": "get-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a [cm_settings object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cm_settings).\n\n#### Example JSON body\n\n[code example]\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 |"
    },
    {
      "id": "put-cm-settings",
      "title": "Update CM settings",
      "role": "content",
      "text": "[code example]\n\nUpdate Cluster Manager UI settings."
    },
    {
      "id": "permissions-1",
      "title": "Permissions",
      "role": "security",
      "text": "| Permission name | Roles |\n|-----------------|-------|\n| [update_cluster](https://redis.io/docs/latest/operate/rs/references/rest-api/permissions#update_cluster) | admin |"
    },
    {
      "id": "put-request",
      "title": "Request",
      "role": "content",
      "text": "#### Example HTTP request\n\n[code example]\n\n#### Example JSON body\n\n[code example]\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](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cm_settings) with updated fields in the request body."
    },
    {
      "id": "put-response",
      "title": "Response",
      "role": "returns",
      "text": "Returns a [cm_settings object](https://redis.io/docs/latest/operate/rs/references/rest-api/objects/cm_settings) with the updated fields.\n\n#### Example JSON body\n\n[code example]\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. |"
    }
  ],
  "examples": [
    {
      "id": "get-cm-settings-ex0",
      "language": "sh",
      "code": "GET /v1/cm_settings",
      "section_id": "get-cm-settings"
    },
    {
      "id": "get-request-ex0",
      "language": "sh",
      "code": "GET /v1/cm_settings",
      "section_id": "get-request"
    },
    {
      "id": "get-response-ex0",
      "language": "json",
      "code": "{\n    \"timezone\": \"UTC\"\n}",
      "section_id": "get-response"
    },
    {
      "id": "put-cm-settings-ex0",
      "language": "sh",
      "code": "PUT /v1/cm_settings",
      "section_id": "put-cm-settings"
    },
    {
      "id": "put-request-ex0",
      "language": "sh",
      "code": "PUT /v1/cm_settings",
      "section_id": "put-request"
    },
    {
      "id": "put-request-ex1",
      "language": "json",
      "code": "{\n    \"timezone\": \"US/Pacific\"\n}",
      "section_id": "put-request"
    },
    {
      "id": "put-response-ex0",
      "language": "json",
      "code": "{\n    \"timezone\": \"US/Pacific\"\n}",
      "section_id": "put-response"
    }
  ]
}