Set cluster authentication mode

Available in VPC

Edit the authentication mode for a created cluster. Once set to API authentication mode, the cluster authentication mode setting can't be turned off or changed.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For headers common to all Ncloud Kubernetes Service APIs, see Common Ncloud Kubernetes Service headers.

Request path parameters

The following describes the parameters.

Request syntax

The request syntax is as follows:

{
  "authType": "string"
}

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/auth-type' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {API gateway signature}' \
--data '{
  "authType": "API"
}'

Response

This section describes the response format.

Response syntax

The response syntax is as follows:

{
    "uuid": "string"
}

Response body

The response body includes the following data:

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 response example is as follows:

{
    "uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
}