> ## Documentation Index > Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Update BYOC Infrastructure > Update configuration of the BYOC infrastructure: rename it, toggle private link and load balancers, or replace its tags. The request is validated as a whole before anything is applied. If applying a field then fails in the data plane, client errors name the fields already applied, while internal errors return a generic message; retrying the same request is safe either way and converges the infrastructure to the requested state. Returns the modified infrastructure Update configuration of the BYOC infrastructure: rename it, toggle private link and load balancers, or replace its tags. The request is validated as a whole before anything is applied. If applying a field then fails in the data plane, client errors name the fields already applied, while internal errors return a generic message; retrying the same request is safe either way and converges the infrastructure to the requested state. Returns the modified infrastructure

Permission

The API key must have the `control-plane:organization:manage` permission.
## OpenAPI ````yaml /_specs/cloud-openapi.json patch /v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId} 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-1222280 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}/byocInfrastructure/{byocInfrastructureId}: patch: tags: - Organization summary: Update BYOC Infrastructure description: >- Update configuration of the BYOC infrastructure: rename it, toggle private link and load balancers, or replace its tags. The request is validated as a whole before anything is applied. If applying a field then fails in the data plane, client errors name the fields already applied, while internal errors return a generic message; retrying the same request is safe either way and converges the infrastructure to the requested state. Returns the modified infrastructure operationId: organizationByocInfrastructureUpdate 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ByocInfrastructurePatchRequest' 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/ByocConfig' '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: ByocInfrastructurePatchRequest: properties: displayName: description: Human readable name for infrastructure object type: string enablePrivateLink: description: >- Enable or disable private link connectivity on the infrastructure. Disabling is rejected while any service in the organization has active private endpoints type: boolean gcpPscSubnetId: description: >- GCP BYO-VPC only: customer-provided Private Service Connect NAT subnet name required to enable private link. Only accepted together with `enablePrivateLink: true` type: string enablePrivateLoadBalancer: description: >- Enable or disable the private (internal) load balancer of the infrastructure type: boolean enablePublicLoadBalancer: description: >- Enable or disable the public (internet-facing) load balancer of the infrastructure type: boolean tags: $ref: '#/components/schemas/ByocInfrastructureTags' ByocConfig: properties: id: description: Unique identifier of the BYOC configuration type: string state: description: State of the infrastructure type: string enum: - infra-provisioning - infra-terminated - infra-terminating - infra-ready - infra-degraded - infra-upgrading example: infra-ready accountId: description: >- Cloud account ID the BYOC infrastructure is bound to: AWS account ID, GCP project ID, or Azure subscription ID type: string example: '123456789012' accountName: description: >- DEPRECATED. Use `accountId` instead. Cloud account ID the BYOC infrastructure is bound to type: string deprecated: true regionId: description: >- Region for which the BYOC has been configured and where it is possible to create services type: string enum: - ap-northeast-1 - ap-northeast-2 - ap-south-1 - ap-southeast-1 - ap-southeast-2 - ca-central-1 - eu-central-1 - eu-west-1 - eu-west-2 - il-central-1 - us-east-1 - us-east-2 - us-west-2 - us-east1 - us-central1 - europe-west2 - europe-west4 - asia-southeast1 - asia-northeast1 - eastus - eastus2 - westus3 - germanywestcentral - centralus cloudProvider: description: Cloud provider of the region type: string enum: - gcp - aws - azure displayName: description: Human readable name for infrastructure type: string ByocInfrastructureTags: type: object additionalProperties: type: string maxProperties: 50 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. ````