Create

Create a new Virtual Cluster.

Valid virtual cluster types: byoc or serverless.

A new agent key is automatically created with every new virtual cluster. The agent key is included in the response to this endpoint.

Request

curl https://api.prod.us-east-1.warpstream.com/api/v1/create_virtual_cluster \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_name": "XXXXXXXXXX", "virtual_cluster_type": "byoc", "virtual_cluster_region": "us-east-1", "virtual_cluster_cloud_provider": "aws"}'

Response

{
    "virtual_cluster_id": "vci_1d4930d7_8e6d_4ad9_b27a_654ed4aaa3ee",
    "virtual_cluster_name": "XXXXXXXXXX",
    "agent_pool_id": "api_417d3bf3_026d_4261_bb16_fe59a4262757",
    "agent_pool_name": "apn_XXXXXXXXXX",
    "agent_key": {
        "id":"aki_007f0341_3ab3_457a_a513_2b2c9415582f",
        "name": "akn_virtual_cluster_XXXXXXXXX_44c7ee374113",
        "key":"aks_a51b1fb20ac4a3af549503bb08cd309672fcada1030c5a494850e87ce5d4c613",
        "created_at":"2024-05-02T18:54:48.990229Z",
        "access_grants": [{
            "principal_kind": "agent",
            "resource_kind":"virtual_cluster",
            "resource_id":"vci_1d4930d7_8e6d_4ad9_b27a_654ed4aaa3ee"
        }]
    }
}