MethodPathDescription
GET/v1/cluster/services_configurationGet cluster services settings
PUT/v1/cluster/services_configurationUpdate cluster services settings

Get cluster services configuration

GET /v1/cluster/services_configuration

Get cluster services settings.

Required permissions

Permission name
view_cluster_info

Request

Example HTTP request

GET /cluster/services_configuration 

Request headers

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

Response

Returns a services configuration object.

Example JSON body

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

Status codes

CodeDescription
200 OKNo error

Update cluster services configuration

PUT /v1/cluster/services_configuration

Update the cluster services settings.

Required permissions

Permission name
update_cluster

Request

Example HTTP request

PUT /cluster/services_configuration 

Example JSON body

{
     "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 with updated fields in the request body.

Response

Returns the updated services configuration object.

Example JSON body

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

Status codes

CodeDescription
200 OKNo error