Clusters
Get cluster
Get information about a Redpanda cluster.
get/v1/clusters/{id}
Request
- Base URL: https://api.redpanda.com
- URL: https://api.redpanda.com/v1/clusters/{id}
- Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)
Path parameters
idstring required
Response
OK
Example response
{
"cluster": {
"adp_api": {
"url": "https://adp-api.cjb69h1c4vs42pca89s0.clusters.rdpa.co"
},
"ai_gateway": {
"url": "https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co",
"v2_url": "https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co"
},
"aws_private_link": {
"allowed_principals": [
"arn:aws:iam::account-number-without-hyphens:user/username or arn:aws:iam::account-number-without-hyphens:root"
],
"status": {
"service_id": "vpce-svc-05fff2117d648da35",
"service_name": "com.amazonaws.vpce.us-west-2.vpce-svc-05fff2117d648da35",
"service_state": "Pending | Available | Deleting | Deleted | Failed",
"vpc_endpoint_connections": [
{
"connection_id": "vpce-con-00b9cba3360fe4aec",
"dns_entries": [
{
"dns_name": "vpce-0751b7ad8a51777f2-1hpievf5.vpce-svc-0d489fa89f24e3802.us-east-2.vpce.amazonaws.com"
}
],
"state": "pendingAcceptance | pending | available | deleting | deleted | rejected | failed"
}
]
}
},
"azure_private_link": {
"allowed_subscriptions": [
"4a73b02e-90c1-4d76-af36-5c935dd41e7c"
],
"status": {
"private_endpoint_connections": [
{
"private_endpoint_id": "/subscriptions/<sub-id>/resourceGroups/<rg-id>/providers/Microsoft.Network/privateEndpoints/<name>",
"status": "Approved | Rejected"
}
],
"service_id": "/subscriptions/<sub-id>/resourceGroups/<rg-id>/providers/Microsoft.Network/privateLinkServices/<name>",
"service_name": "pls-name"
}
},
"dataplane_api": {
"url": "https://api-ab1234l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com"
},
"gcp_private_service_connect": {
"consumer_accept_list": [
{
"source": "gcp-project-1"
}
]
},
"http_proxy": {
"mtls": {
"ca_certificates_pem": [
"-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
],
"principal_mapping_rules": [
"RULE:.*CN=([^,]+).*/$1/"
]
},
"url": "https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092"
},
"kafka_api": {
"mtls": {
"ca_certificates_pem": [
"-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
],
"principal_mapping_rules": [
"RULE:.*CN=([^,]+).*/$1/"
]
}
},
"name": "development-cluster",
"network_id": "cjcuq79c4vs94fcufc2g",
"prometheus": {
"url": "https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics"
},
"redpanda_console": {
"url": "https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api"
},
"region": "us-central1",
"resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
"sandbox": {
"url": "https://sandbox.cjb69h1c4vs42pca89s0.clusters.rdpa.co"
},
"schema_registry": {
"mtls": {
"ca_certificates_pem": [
"-----BEGIN CERTIFICATE-----\nMII........\n-----END CERTIFICATE-----"
],
"principal_mapping_rules": [
"RULE:.*CN=([^,]+).*/$1/"
]
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.