Skip to main content
PATCH
Update organization preview feature
Beta Disclaimer: This beta endpoint is evolving; the API contract may change.

Switches a preview feature on or off for the organization. Use an ID returned by the list endpoint; an unknown ID returns 404. Only previews offered to the organization can be switched on, otherwise the request returns 403; switching off is always allowed.

Permission

The API key must have the control-plane:organization:manage permission.

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 requested organization.

previewId
string
required

ID of the requested preview feature.

Body

application/json
enabled
boolean
required

Whether the preview feature should be on.

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object