Organization

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.

get/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}/progress
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

byocInfrastructureIdstring uuid required

ID of the requested BYOC Infrastructure

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200,
  "result": {
    "status": "in_progress",
    "stages": [
      {
        "name": "vpc",
        "status": "ready"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.