Cluster services configuration requests

Cluster services configuration requests

Method Path Description
GET /v1/cluster/services_configuration Get cluster services settings
PUT /v1/cluster/services_configuration Update 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

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted 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

Code Description
200 OK No 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

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted 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

Code Description
200 OK No error
RATE THIS PAGE
Back to top ↑