Skip to main content
POST
Create BYOC infrastructure enrollment token
Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

Restricted access only. Mints a token the connector enrolls the infrastructure with. Every call mints a new token; earlier tokens stay valid until they expire. Answers 409 until ClickHouse has admitted the roles the infrastructure registered, which follows creation within minutes.

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.

byocInfrastructureId
string<uuid>
required

ID of the requested BYOC Infrastructure

Body

application/json
ttlSeconds
integer

Lifetime of the token in seconds: whole minutes between 3600 and 86400. Omitted: four hours

Required range: 3600 <= x <= 86400

Response

Successful response

status
number

HTTP status code.

Example:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object