Skip to main content

Download Cluster kubeconfig

Returns the cluster's kubeconfig file - the credentials and endpoint used by kubectl and other clients to connect to the cluster's API server. Save the response as your ~/.kube/config (or merge it in). Use the cluster service_id.

GET/api/v1/kubernetes/cluster-config-download/{service_id}/

Path parameters

  • service_idPathintegerrequired

    The cluster service_id, as returned by List.

    • required
    • must be a valid cluster service ID
    example12345

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object

The cluster's kubeconfig, returned as YAML text (fields vary by cluster).

codeinteger
example200
datastring

The kubeconfig file contents.

exampleapiVersion: v1 clusters: - cluster: server: https://203.0.113.10:6443 name: my-k8s-cluster contexts: - context: cluster: my-k8s-cluster user: admin-user name: my-k8s-cluster current-context: my-k8s-cluster kind: Config users: - name: admin-user user: token: <token>
errorsobject
messagestring
exampleSuccess