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 region is then taken from the infrastructure and region_id may be omitted. The list is empty when the organization tier does not include custom hardware profiles.

Permission

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

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

organizationId
string<uuid>
requis

ID of the organization to list available profiles for.

Paramètres de requête

region_id
string

Region to list profiles for, e.g. us-east-1. Required unless byoc_id is set; when both are set it must match the BYOC infrastructure's region.

byoc_id
string<uuid>

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

Réponse

Successful response

status
number

HTTP status code.

Exemple:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object[]
Dernière modification le 18 septembre 2026