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

# Clickhouse Organization Byoc Infrastructure Update:

> Update BYOC Infrastructure. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=clickhouse_organization_byoc_infrastructure_update:{"organizationId":"{{organizationId}}","byocInfrastructureId":"{{byocInfrastructureId}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                           | Type     | Required | Default | Description                                   |
| ------------------------------ | -------- | -------- | ------- | --------------------------------------------- |
| `payload.organizationId`       | `string` | Yes      |         | ID of the requested organization.             |
| `payload.byocInfrastructureId` | `string` | Yes      |         | ID of the requested BYOC Infrastructure       |
| `payload.displayName`          | `string` | No       |         | Human readable name for infrastructure object |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Update configuration of the BYOC infrastructure. Returns the modified infrastructure",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      },
      "byocInfrastructureId": {
        "type": "string",
        "description": "ID of the requested BYOC Infrastructure",
        "format": "uuid"
      },
      "displayName": {
        "type": "string",
        "description": "Human readable name for infrastructure object"
      }
    },
    "required": [
      "organizationId",
      "byocInfrastructureId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "status": {
            "type": "number",
            "description": "HTTP status code."
          },
          "requestId": {
            "type": "string",
            "description": "Unique id assigned to every request. UUIDv4",
            "format": "uuid"
          },
          "result": {
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier of the BYOC configuration"
              },
              "state": {
                "type": "string",
                "description": "State of the infrastructure",
                "enum": [
                  "infra-ready",
                  "infra-provisioning",
                  "infra-terminated"
                ]
              },
              "accountName": {
                "type": "string",
                "description": "Name of the account"
              },
              "regionId": {
                "type": "string",
                "description": "Region for which the BYOC has been configured and where it is possible to create services",
                "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": {
                "type": "string",
                "description": "Cloud provider of the region",
                "enum": [
                  "gcp",
                  "aws",
                  "azure"
                ]
              },
              "displayName": {
                "type": "string",
                "description": "Human readable name for infrastructure"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute clickhouse_organization_byoc_infrastructure_update --payload '{
  "organizationId": "string",
  "byocInfrastructureId": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.