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

# Get BYOC infrastructure provisioning progress

> **Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the stage-by-stage provisioning progress of a BYOC infrastructure, more granular than the `state` field: overall status plus a tree of provisioning stages down to individual cloud resources.

<span data-endpoint-badge="Beta"><Badge color="blue">Beta</Badge></span>

**Disclaimer:** This beta endpoint is evolving; the API contract may change. <br /><br /> Returns the stage-by-stage provisioning progress of a BYOC infrastructure, more granular than the `state` field: overall status plus a tree of provisioning stages down to individual cloud resources.

<div data-permissions class="api-section">
  <div class="api-section-heading flex flex-col gap-y-4 w-full">
    <div class="flex items-baseline border-b pb-2.5 border-gray-100 dark:border-gray-800 w-full">
      <h4 class="api-section-heading-title flex-1 mb-0">Permission</h4>
    </div>
  </div>

  <div class="py-6">
    The API key must have the `control-plane:organization:view` permission.
  </div>
</div>


## OpenAPI

````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress
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-1173305
    email: support@clickhouse.com
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - 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
paths:
  /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress:
    get:
      tags:
        - Organization
      summary: Get BYOC infrastructure provisioning progress
      description: >-
        **Disclaimer:** This beta endpoint is evolving; the API contract may
        change. <br /><br /> Returns the stage-by-stage provisioning progress of
        a BYOC infrastructure, more granular than the `state` field: overall
        status plus a tree of provisioning stages down to individual cloud
        resources.
      operationId: organizationByocInfrastructureProgressGet
      parameters:
        - in: path
          name: organizationId
          description: ID of the requested organization.
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: byocInfrastructureId
          description: ID of the requested BYOC Infrastructure
          required: true
          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:
                    $ref: '#/components/schemas/ByocInfrastructureProgress'
        '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:
    ByocInfrastructureProgress:
      properties:
        id:
          description: Unique identifier of the BYOC infrastructure
          type: string
        status:
          description: Overall provisioning status of the infrastructure
          type: string
          enum:
            - not_started
            - pending
            - waiting
            - in_progress
            - ready
            - failed
          example: in_progress
        updatedAt:
          description: Timestamp the overall status last changed. ISO-8601
          type: string
          format: date-time
        stages:
          type: array
          description: Top-level provisioning stages with their nested resources
          items:
            $ref: '#/components/schemas/ByocInfrastructureProgressStage'
    ByocInfrastructureProgressStage:
      properties:
        name:
          description: Name of the provisioning stage or resource
          type: string
          example: vpc
        status:
          description: Status of this stage
          type: string
          enum:
            - not_started
            - pending
            - waiting
            - in_progress
            - ready
            - failed
          example: ready
        updatedAt:
          description: Timestamp the stage status last changed. ISO-8601
          type: string
          format: date-time
        message:
          description: Human readable detail for the current status, e.g. an error message
          type: string
        subStages:
          type: array
          description: Nested stages; leaf entries are individual cloud resources
          items:
            $ref: '#/components/schemas/ByocInfrastructureProgressStage'
  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.

````