Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Get BYOC infrastructure provisioning progress

GET/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress
API playground

Disclaimer: This beta endpoint is evolving; the API contract may change.

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.

Permission

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

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the requested organization.

    format: uuid
  • byocInfrastructureIdstringrequired

    ID of the requested BYOC Infrastructure

    format: uuid

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    4 properties
    • idoptionalstring

      Unique identifier of the BYOC infrastructure

    • statusoptionalnot_startedorpendingorwaitingorin_progressorreadyorfailed

      Overall provisioning status of the infrastructure

      Example: "in_progress"
    • updatedAtoptionalstring

      Timestamp the overall status last changed. ISO-8601

      format: date-time
    • stagesoptionalarray ofobject

      Top-level provisioning stages with their nested resources

      5 properties
      • nameoptionalstring

        Name of the provisioning stage or resource

        Example: "vpc"
      • statusoptionalnot_startedorpendingorwaitingorin_progressorreadyorfailed

        Status of this stage

        Example: "ready"
      • updatedAtoptionalstring

        Timestamp the stage status last changed. ISO-8601

        format: date-time
      • messageoptionalstring

        Human readable detail for the current status, e.g. an error message

      • subStagesoptionalarray ofobject

        Nested stages; leaf entries are individual cloud resources

        5 properties
        • nameoptionalstring

          Name of the provisioning stage or resource

          Example: "vpc"
        • statusoptionalnot_startedorpendingorwaitingorin_progressorreadyorfailed

          Status of this stage

          Example: "ready"
        • updatedAtoptionalstring

          Timestamp the stage status last changed. ISO-8601

          format: date-time
        • messageoptionalstring

          Human readable detail for the current status, e.g. an error message

        • subStagesoptionalarray ofobject

          Nested stages; leaf entries are individual cloud resources