Back to Redis

Services Configuration

content/operate/rs/references/rest-api/requests/cluster/services_configuration.md

latest2.8 KB
Original Source
MethodPathDescription
GET/v1/cluster/services_configurationGet cluster services settings
PUT/v1/cluster/services_configurationUpdate cluster services settings

Get cluster services configuration {#get-cluster-services_config}

GET /v1/cluster/services_configuration

Get cluster services settings.

Required permissions

Permission name
[view_cluster_info]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_info" >}})

Request {#get-request}

Example HTTP request

GET /v1/cluster/services_configuration 

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Response {#get-response}

Returns a [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}).

Example JSON body

json
{
     "cm_server": {
         "operating_mode": "disabled"
     },
     "mdns_server": {
         "operating_mode": "enabled"
     },
     "// additional services..."
}

Status codes {#get-status-codes}

CodeDescription
200 OKNo error

Update cluster services configuration {#put-cluster-services_config}

PUT /v1/cluster/services_configuration

Update the cluster services settings.

Required permissions

Permission name
[update_cluster]({{< relref "/operate/rs/references/rest-api/permissions#update_cluster" >}})

Request {#put-request}

Example HTTP request

PUT /v1/cluster/services_configuration 

Example JSON body

json
{
     "cm_server": {
         "operating_mode": "disabled"
     },
     "// additional services..."
}

Request headers

KeyValueDescription
Hostcnm.cluster.fqdnDomain name
Acceptapplication/jsonAccepted media type

Request body

Include a [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}) with updated fields in the request body.

Response {#put-response}

Returns the updated [services configuration object]({{< relref "/operate/rs/references/rest-api/objects/services_configuration" >}}).

Example JSON body

json
{
     "cm_server": {
         "operating_mode": "disabled"
     },
     "mdns_server": {
         "operating_mode": "enabled"
     },
     "// additional services..."
}

Status codes {#put-status-codes}

CodeDescription
200 OKNo error