Skip to main content

Generate Kubeconfig for a cluster

POST 
/api/v1/clusters/:clusterId/kubeconfig

Generates the kubeconfig file for a specific Kubernetes cluster (requires admin or platform-admin role).

Request​

Path Parameters

    clusterId stringrequired

    Cluster Id

Header Parameters

    X-API-KEY stringrequired

    API Key

Body

required

Kubeconfig generation data

    clusterName stringrequired

    Possible values: non-empty and <= 50 characters

    clusterName is the name of the cluster

    credentials

    object

    required

    data

    object

    required

    data is the data for the credentials, the data is in the format of key-value pairs

    property name* string
    type stringrequired

    Possible values: [static, dynamic]

    type is the type of the credentials it expects, the supported types are static and dynamic if the type is static then platform aspects the standard ENV keys for cloud provider. Please follow the astro platform documentation for the keys. If the type is dynamic then the platform will use cloud provider supported capability to generate the credentials. Like for AWS it will use the STS assume role capability.

    duration integerrequired

    Possible values: [-9223372036854776000, 9223372036854776000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000]

Responses​

Kubeconfig file

Schema

    data string
    id string
    message string
    status string
Loading...