Available in VPC
View the kubeconfig configuration file for the cluster.
Note
- Clusters created on or after February 13, 2022 have IAM authentication automatically applied, so you can't view the kubeconfig configuration file through this API.
- For clusters created before February 13, 2022, you can configure the kubeconfig configuration file with ncp-iam-authenticator to control cluster permissions by IAM service (Sub Account) account through IAM authentication
Requests
The following describes the request format for the endpoint. The request format is as follows.
| Method | URI |
|---|---|
| GET | /vnks/v2/clusters/{uuid}/kubeconfig (Korea Region) |
| GET | /vnks/sgn-v2/clusters/{uuid}/kubeconfig (Singapore Region) |
| GET | /vnks/jpn-v2/clusters/{uuid}/kubeconfig (Japan Region) |
Request headers
For information about the headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service request headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
String | Required | UUID of the cluster |
Request example
The following is a sample request.
curl --location 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/kubeconfig' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Responses
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"kubeconfig": "string"
}
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
kubeconfig |
String | - | JSON value of kubeconfig |
Response status codes
For information about the HTTP status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.
Response example
The following is a sample response.
{
"kubeconfig": "apiVersion: v1\nclusters:\n - cluster:\n certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM2VENDQWRHZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQ0FYRFRJME1ETXlPREEwTURnd01sb1lEekl4TWpRd016QTBNRFF3T0RBeVdqQVZNUk13RVFZRApWUVFERXdwcmRXSmxjbTVsZEdWek1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBCnBvNVJJRjZ4SldWaDM4RTlaVndYNkp5YUZrbFZ2VEpaYmRzdFc4bWxKeGwrOUVzMUhHYjB5YWNyOTlhN3draWIKUVdCREYwSTdhcSsrZVYyM25QMk0zbjJVTXluSzltTDl0SFhSVHB4eVhBR2llRHFNUkUvU2YvbkV2RVhzMzJsUApGOUdLZ0dYUko5Vk90c3NsRy9IaEd0MmFrVmZlYStSRHhZOUtzN1dnNGMzQzNGZ1pKaUNlUTcyY2dYZkdQbW10CmQ2VUVQT0Q1eURYdXlIbFhQWnR3V0MxMTRhdEs1ZC9VN0hJc1VQMSt0aWZNNnJHMkh3US9md2pCUUdhYUpPaEoKb01tdmUvVmYyUjRXcjV3cTFSM2xkRjBLemY1c1d5S3dabGZQcW9qZDByUElmUjBxTTJJaU01cDlOQkRHeGYzMApkdGtMeVpsWXFqczFqbzBNLzhvcWR3SURBUUFCbzBJd1FEQU9CZ05WSFE4QkFmOEVCQU1DQXFRd0R3WURWUjBUCkFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVUyRkpqbTFMRGZDZFE5WFBvM29uWWVKaXlwejh3RFFZSktvWkkKaHZjTkFRRUxCUUFEZ2dFQkFLUEFlcEdUVWl0QXpyUS9CM044dWlXY3pxZ0tWODd0N0N1WEVydlI1OGhoWXFPMApuMHJ4YjdoME5ubUN1TUYrMlZmQ0RmS2JYWWc5dDhTbFFpNzdpcEN2OUIwdDhpQ1AyM3BuMlB6Y3ZObjMxeGxvCllwUDMxekNGSk1VOElncndXZDNMdGlQSXZCSG9hMVlTalY3QWdNb01wMGtOQ3hEbm85dkI0b1Y4a2JKKzdha0cKMEdJN0hpOFRHS1l5Y2xURWFPem83TzZCa2ZLMVJTcC9tMzg1R201bzdCRlE4V05iVk5XaFpUdGN6V0M5MGhLeQo5VGMwZDVXMTNmeDJrTGxEN08vd0M2alZMa0EyV2NXVVBGd3RIRk4wNlJNZTRKQWNsQjFtTUcvNmNBQUNobnJ5ClRUWDZZR2NRWHVtWG12WFRxOTc1K3pnUXpUNkxhaWxEdkVuanN1Yz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=\n server: https://1a1111a1-4d44-99b9-88c8-9e99a99e9e99.kr.vnks.ntruss.com\n name: kubernetes\ncontexts:\n - context:\n cluster: kubernetes\n user: kubernetes-admin\n name: kubernetes-admin@kubernetes\ncurrent-context: kubernetes-admin@kubernetes\nkind: Config\npreferences: {}\n"
}