> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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. 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).

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.


## OpenAPI

````yaml /_specs/cloud-openapi.json get /v1/organizations/{organizationId}/serviceProfiles
openapi: 3.1.1
info:
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1422730
    email: support@clickhouse.com
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: Notifications
  - name: User management
  - name: Billing
  - name: Role Management
  - name: Service
  - name: Backup
  - name: Snapshot
  - name: API keys
  - name: Prometheus
  - name: ClickPipes
  - name: ClickStack
  - name: Postgres
  - name: UDF
  - name: Query API endpoints
  - name: Saved queries
paths:
  /v1/organizations/{organizationId}/serviceProfiles:
    get:
      tags:
        - Service
      summary: List available service profiles
      description: >-
        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).
      operationId: serviceProfilesList
      parameters:
        - in: path
          name: organizationId
          description: ID of the organization to list available profiles for.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: region_id
          description: >-
            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.
          schema:
            type: string
        - in: query
          name: byoc_id
          description: >-
            ID of the BYOC infrastructure to list profiles for. BYOC profiles
            are only returned when this is set.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServiceProfile'
        '400':
          description: >-
            The request cannot be processed due to a client error. Please verify
            your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: >-
            An internal server error has occurred. If this issue persists,
            please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
components:
  schemas:
    ServiceProfile:
      properties:
        profile:
          description: >-
            Profile name to pass as `profile` when creating a service (e.g.
            'v1-standard-byoc-4').
          type: string
        cpuCores:
          description: >-
            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.
          type: number
        memoryGi:
          description: >-
            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.
          type: number
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Use key ID and key secret obtained in ClickHouse Cloud console:
        https://clickhouse.com/docs/cloud/manage/openapi
      x-permission-scopes: >-
        The scope list of a `security` requirement holds ClickHouse Cloud API
        key permission ids (for example `control-plane:organization:view`), not
        OAuth scopes. OpenAPI has no field for API key permissions, so this is
        the closest available place. A key must hold every permission listed on
        an operation to call it; an operation with no scopes needs none beyond a
        valid key. Every operation declares at most one requirement object,
        always for this scheme, so the list is only ever conjunctive —
        alternative sets of permissions are never expressed.

````