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.

Авторизации

Authorization
string
header
обязательно

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

Параметры пути

organizationId
string<uuid>
обязательно

ID of the organization to list available profiles for.

Параметры запроса

region_id
string
обязательно

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.

Ответ

Successful response

status
number

HTTP status code.

Пример:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
Последнее изменение 26 августа 2026 г.