Available in VPC
Set whether the cluster is protected from termination.
Requests
The following describes the request format for the endpoint. The request format is as follows.
Method | URI |
---|---|
PATCH | /clusters/{uuid}/return-protection |
Request headers
For headers common to all Ncloud Kubernetes Service APIs, see Ncloud Kubernetes Service common request 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.
{
"returnProtection": "Boolean"
}
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
returnProtection |
Boolean | Required | Whether to set termination protection
|
Request example
The following is a sample request.
curl --location --request PATCH 'https://nks.apigw.ntruss.com/vnks/v2/clusters/0000a20e-e0fb-4dc9-af1b-97fd3f8d0000/return-protection' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"returnProtection": true
}'
Responses
The following describes the response format.
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 response.
{
"uuid": "0000a20e-e0fb-4dc9-af1b-97fd3f8d0000"
}