Skip to main content
GET
List available service profiles
Returns the custom instance profiles the organization can use in a region. Pass byoc_id to list the profiles configured for a BYOC infrastructure. The list is empty when the organization tier does not include custom hardware profiles.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

organizationId
string<uuid>
obrigatório

ID of the organization to list available profiles for.

Parâmetros de consulta

region_id
string
obrigatório

Region to list profiles for, e.g. us-east-1.

byoc_id
string<uuid>

ID of the BYOC infrastructure to list profiles for. BYOC profiles are only returned when this is set.

Resposta

Successful response

status
number

HTTP status code.

Exemplo:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
Última modificação em 26 de agosto de 2026