Skip to content

Get cluster connection details API Reference

GET
/tenants/{tenant}/clusters/{name}/connection-details
curl --request GET \
--url https://api.kupe.cloud/api/v1/tenants/acme/clusters/production/connection-details \
--header 'Authorization: <Authorization>'

Retrieve the API endpoint and CA certificate for connecting to a managed cluster. Use these details to assemble a kubeconfig with your own auth (OIDC, etc.).

tenant
required
string

Tenant name

name
required
string

Cluster name

Connection details

Media type application/json
object
certificateAuthority
string
endpoint
string
Example
{
"certificateAuthority": "LS0tLS1CRUdJTi...",
"endpoint": "https://production.acme.clusters.kupe.cloud"
}

Invalid name

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}

Missing or invalid authentication

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}

Not a member of this tenant

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}

Cluster not found

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}

Rate limit exceeded

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}

Cluster is not yet ready

Media type application/json
object
code
string
error
string
field
string
message
string
severity
string
Example generated
{
"code": "example",
"error": "example",
"field": "example",
"message": "example",
"severity": "example"
}