Service

Update service state

Starts, stops, or wakes a service. The start and stop commands require the control-plane:service:manage permission on the service. The awake command requires only control-plane:service:view and applies to an idle service; it does not start a stopped service.

patch/v1/organizations/{organizationId}/services/{serviceId}/state

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/state
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the organization that owns the service.

serviceIdstring uuid required

ID of the service to update state.

Request body

command'start' | 'stop' | 'awake' required

Command to change the state: 'start', 'stop', 'awake'.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "endpoints": [
      {
        "protocol": "mysql"
      }
    ],
    "minTotalMemoryGb": 48,
    "maxTotalMemoryGb": 360,
    "minReplicaMemoryGb": 16,
    "maxReplicaMemoryGb": 120,
    "numReplicas": 3,
    "minReplicas": 1,
    "maxReplicas": 5,
    "autoscalingMode": "vertical",
    "replicaMemoryGb": 32,
    "tags": [
      {
        "key": "Environment",
        "value": "staging"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.