- Print
- PDF
Set cluster authentication mode
- Print
- PDF
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
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
PATCH | /clusters/{uuid}/auth-type |
Request headers
For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common headers.
Request path parameters
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
uuid | String | Required | Cluster's UUID
|
Request syntax
The request syntax is as follows.
{
"authType": "string"
}
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
authType | String | Required | Authentication mode code
|
Request example
The following is a sample request.
curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/{uuid}/secret-encryption' \
--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
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"uuid": "string"
}
Response body
The following describes the response body.
Field | Type | Required | Description |
---|---|---|---|
uuid | String | - | UUID of the cluster |
Response status codes
For response status codes common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service response status codes.
Response example
The following is a sample example.
{
"uuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****"
}