Skip to content
WarpStream Documentation
Start Free

Describe

Describe a specific Virtual Cluster by ID.

Request

Section titled “Request”
 curl https://api.warpstream.com/api/v1/describe_virtual_cluster \
 -H 'warpstream-api-key: XXXXXXXXXX' \
 -H 'Content-Type: application/json' \
 -d '{"virtual_cluster_id": "vci_1d4980d7_8e6d_4ad9_b27a_656ed4aca3ee"}'

Response

Section titled “Response”
{
  "virtual_cluster": {
    "id": "vci_1d4980d7_8e6d_4ad9_b27a_656ed4aca3ee",
    "agent_keys": [{
      "id":"aki_007f0341_3ab3_457a_a513_2b2c9415582f",
      "name": "akn_virtual_cluster_default_d68d456aed4f",
      "key":"aks_a51b1fb20ac4a3af549503bb08cd309672fcada1030c5a494850e87ce5d4c613",
      "created_at":"2024-05-02T18:54:48.990229Z",
      "access_grants": [{
        "principal_kind": "agent",
        "resource_kind":"virtual_cluster",
        "resource_id":"vci_1d4980d7_8e6d_4ad9_b27a_656ed4aca3ee"
      }]
    }],
    "agent_pool_id": "api_69112707_3f34_435c_b47e_6efc94c1f125",
    "agent_pool_name": "apn_default",
    "name": "vcn_default",
    "created_at": "2023-08-25T21:35:29.338204Z",
    "type": "byoc",
    "region": "us-east-1",
    "cloud_provider": "aws",
    "bootstrap_url": "api-69112707-3f34-435c-b47e-6efc94c1f125.kafka.discoveryv2.prod-z.us-east-1.warpstream.com:9092",
    "tier": "pro"
  },
  "catalog_base_url": null
}