> ## 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 Cloud: Clickhouse Organization Byoc Infrastructure Create

> Set up Bring Your Own Cloud infrastructure for a ClickHouse Cloud organization in your cloud account. Includes SDK V2 examples, schemas, and cost.

Set up Bring Your Own Cloud infrastructure for a ClickHouse Cloud organization in your cloud account.

> [!NOTE]
>
> Tool ID: `clickhouse_organization_byoc_infrastructure_create`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clickhouse_organization_byoc_infrastructure_create',
  {
    "organizationId": "123e4567-e89b-42d3-a456-426614174000"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute clickhouse_organization_byoc_infrastructure_create --input '{
  "organizationId": "123e4567-e89b-42d3-a456-426614174000"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "status": 123,
    "requestId": "123e4567-e89b-42d3-a456-426614174000",
    "result": {
      "id": "id_123",
      "state": "infra-ready",
      "accountName": "Example"
    }
  }
}
```

Use `deepline describe clickhouse_organization_byoc_infrastructure_create --json` for the latest machine-readable contract.

## Input reference

Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizationId` | `string` | Yes | — | ID of the requested organization. Format: `uuid`. |
| `payload.regionId` | `"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"` | No | — | Region in which the BYOC infrastructure will be located Allowed: `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`. |
| `payload.accountId` | `string` | No | — | Cloud account ID the BYOC infrastructure is configured for |
| `payload.availabilityZoneSuffixes` | `array` | No | — | List of availability zone suffixes |
| `payload.vpcCidrRange` | `string` | No | — | CIDR range for VPC |
| `payload.displayName` | `string` | No | — | Human readable name for infrastructure |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure",
    "properties": {
      "organizationId": {
        "type": "string",
        "description": "ID of the requested organization.",
        "format": "uuid"
      },
      "regionId": {
        "type": "string",
        "description": "Region in which the BYOC infrastructure will be located",
        "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"
        ]
      },
      "accountId": {
        "type": "string",
        "description": "Cloud account ID the BYOC infrastructure is configured for"
      },
      "availabilityZoneSuffixes": {
        "type": "array",
        "description": "List of availability zone suffixes",
        "items": {
          "type": "string",
          "enum": [
            "a",
            "b",
            "c",
            "d",
            "e",
            "f"
          ]
        }
      },
      "vpcCidrRange": {
        "type": "string",
        "description": "CIDR range for VPC"
      },
      "displayName": {
        "type": "string",
        "description": "Human readable name for infrastructure"
      }
    },
    "required": [
      "organizationId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.status` | `number` | No | — | HTTP status code. |
| `result.data.requestId` | `string` | No | — | Unique id assigned to every request. UUIDv4 Format: `uuid`. |
| `result.data.result` | `object` | No | — | — |
| `result.data.result.id` | `string` | No | — | Unique identifier of the BYOC configuration |
| `result.data.result.state` | `"infra-ready" \| "infra-provisioning" \| "infra-terminated"` | No | — | State of the infrastructure Allowed: `infra-ready`, `infra-provisioning`, `infra-terminated`. |
| `result.data.result.accountName` | `string` | No | — | Name of the account |
| `result.data.result.regionId` | `"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"` | No | — | Region for which the BYOC has been configured and where it is possible to create services Allowed: `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`. |
| `result.data.result.cloudProvider` | `"gcp" \| "aws" \| "azure"` | No | — | Cloud provider of the region Allowed: `gcp`, `aws`, `azure`. |
| `result.data.result.displayName` | `string` | No | — | Human readable name for infrastructure |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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>

## Deepline cost

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

## Related documentation

* [ClickHouse Cloud provider guide](https://deepline.com/docs/providers/clickhouse/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.