Skip to main content
PATCH
Update service basic details
Updates basic service details like service name or IP access list.

Authorizations

Authorization
string
header
required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId
string<uuid>
required

ID of the organization that owns the service.

serviceId
string<uuid>
required

ID of the service to update.

Body

application/json
name
string

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

Required string length: 1 - 50
ipAccessList
object
privateEndpointIds
object
releaseChannel
enum<string>

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.

Available options:
slow,
default,
fast
endpoints
object[]

List of service endpoints to change

transparentDataEncryptionKeyId
string

The id of the key to rotate

tags
object
enableCoreDumps
boolean

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

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object
Last modified on July 21, 2026