Services

Service management

List services

get

Lists all services

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters

hoststringOptional

Filter by host name

binarystringOptional

Filter by binary

clusterstringOptional

Filter by cluster name

Responses

200

OK

application/json

get

/v3/os-services

HTTPcURLJavaScriptPython

GET /cinder/v3/os-services HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "services": [
    {
      "binary": "text",
      "host": "text",
      "zone": "text",
      "status": "text",
      "state": "text",
      "updated_at": "2025-12-19T16:21:41.827Z",
      "disabled_reason": "text",
      "cluster": "text",
      "frozen": true,
      "replication_status": "text",
      "active_backend_id": "text"
    }
  ]
}

Update service

put

Updates a service

Authorizations

pcdAuth

X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body

application/json

Responses

200

OK

application/json

put

/v3/os-services

HTTPcURLJavaScriptPython

PUT /cinder/v3/os-services HTTP/1.1
Host: example.platform9.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "body": {
    "disabled": true,
    "disabled_reason": "text"
  }
}

200

OK

{
  "service": {
    "binary": "text",
    "host": "text",
    "zone": "text",
    "status": "text",
    "state": "text",
    "updated_at": "2025-12-19T16:21:41.827Z",
    "disabled_reason": "text",
    "cluster": "text",
    "frozen": true,
    "replication_status": "text",
    "active_backend_id": "text"
  }
}