API How-Tos

All Kubernetes API instructions can be found in the main Cloud API specification file.

Cloud API - Open API Specification file

To access the Kubernetes API, which the cluster provides, you can download the kubeconfig file and use it with tools such as kubectl.

Get Kubernetes Configuration Files

Quick Links

Set User Privileges

Learn how to set user privileges to create and manage Kubernetes cluster and node pools via the API.

Retrieve Kubernetes configuration files

GET https://api.ionos.com/cloudapi/v6/k8s/{k8sClusterId}/kubeconfig

Retrieve a configuration file for the specified Kubernetes cluster, in YAML or JSON format as defined in the Accept header; the default Accept header is application/yaml.

Path Parameters

Name	Type	Description
k8sClusterId*	String	The unique ID of the Kubernetes cluster.

Query Parameters

Name	Type	Description
depth	String	Controls the detail depth of the response objects.

Headers

Name	Type	Description
X-Contract-Number	Integer	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

200: OK Successful operation

{}

400: Bad Request Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error)), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

{
    "httpStatus": 400,
    "messages": {
        "errorCode": "123",
        "message": "Error message example."
    }
}