Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

List available service profiles

GET/v1/organizations/{organizationId}/serviceProfiles
API playground

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. v2-default (Gen 2 hardware) is listed for organizations with Gen 2 enabled and included in their plan (SCALE or ENTERPRISE) or settings, in AWS regions where Gen 2 is available, and never for BYOC infrastructure. Some other profiles have their own availability rules; every other profile, v1-default included, is listed only when the organization has custom hardware profiles (through its plan or a per-organization override).

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization to list available profiles for.

    format: uuid

Query parameters

  • region_idoptionalstring

    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_idoptionalstring

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

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofobject
    3 properties
    • profileoptionalstring

      Profile name to pass as profile when creating a service (e.g. 'v1-standard-byoc-4').

    • cpuCoresoptionalnumber

      Number of vCPUs per replica. For v2-default, ignore this value: a Gen 2 service's size is set by the minReplicaMemoryGb and maxReplicaMemoryGb you send when creating or scaling it, not by the profile.

    • memoryGioptionalnumber

      Memory per replica in GiB. A BYOC service pinned to this profile must send minReplicaMemoryGb and maxReplicaMemoryGb equal to this value. A BYOC service that scales vertically (no profile, minReplicaMemoryGb lower than maxReplicaMemoryGb) takes both bounds from the memoryGi values in this list. For v2-default, ignore this value: a Gen 2 service's size is set by the minReplicaMemoryGb and maxReplicaMemoryGb you send when creating or scaling it, not by the profile.