Service

Update service basic details

Updates basic service details like service name or IP access list.

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

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}
  • 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.

Request body

namestring

Name of the service. Alphanumerical string with whitespaces up to 50 characters.

releaseChannel'slow' | 'default' | 'fast'

Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.

transparentDataEncryptionKeyIdstring

The id of the key to rotate

enableCoreDumpsboolean

If true, the underlying infra is enabled for collecting core dumps.

Example request

{
  "endpoints": [
    {
      "protocol": "mysql"
    }
  ],
  "tags": {
    "add": [
      {
        "key": "Environment",
        "value": "staging"
      }
    ],
    "remove": [
      {
        "key": "Environment",
        "value": "staging"
      }
    ]
  }
}

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.