Cluster Manager settings requests
REST API requests for Cluster Manager UI settings
| Method | Path | Description |
|---|---|---|
| GET | /v1/cm_settings |
Get Cluster Manager UI settings |
| PUT | /v1/cm_settings |
Update Cluster Manager UI settings |
Get CM settings
GET /v1/cm_settings
Get Cluster Manager UI settings.
Permissions
| Permission name | Roles |
|---|---|
| view_cluster_info | admin cluster_member cluster_viewer db_member db_viewer user_manager |
Request
Example HTTP request
GET /cm_settings
Headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Response
Returns a cm_settings object.
Example JSON body
{
"timezone": "UTC"
}
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |
Update CM settings
PUT /v1/cm_settings
Update Cluster Manager UI settings.
Permissions
| Permission name | Roles |
|---|---|
| update_cluster | admin |
Request
Example HTTP request
PUT /cm_settings
Example JSON body
{
"timezone": "US/Pacific"
}
Headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
Body
Include a cm_settings object with updated fields in the request body.
Response
Returns a cm_settings object with the updated fields.
Example JSON body
{
"timezone": "US/Pacific"
}
Status codes
| Code | Description |
|---|---|
| 200 OK | Success, time zone config has been set. |
| 400 Bad Request | Bad or missing configuration parameters. |