setProtectServerTermination

Prev Next

Available in VPC

Set the termination protection status for a server instance (VM).

Request

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

Method URI
GET | POST /vserver/v2/setProtectServerTermination
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Server APIs, see Server request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
serverInstanceNo String Required Server instance number
isProtectServerTermination Boolean Required Termination protection status
  • true | false
    • true: protected
    • false: not protected
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/setProtectServerTermination
?regionCode=KR
&serverInstanceNo=*****8773
&isProtectServerTermination=true
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
setProtectServerTerminationResponse Object - Response result
setProtectServerTerminationResponse.returnCode String - Response code
setProtectServerTerminationResponse.returnMessage String - Response message

Response status codes

For information about the response status codes common to all Server APIs, see Server response status codes.

Response example

The response example is as follows:

{
    "setProtectServerTerminationResponse": {
        "totalRows": 1,
        "serverInstanceList": [
            {
                "serverInstanceNo": "*****8773",
                "serverName": "test-***",
                "cpuCount": 4,
                "memorySize": 8589934592,
                "platformType": {
                    "code": "UBD64",
                    "codeName": "Ubuntu Desktop 64 Bit"
                },
                "loginKeyName": "test-***",
                "publicIpInstanceNo": "*****8824",
                "publicIp": "211.188.***.***",
                "serverInstanceStatus": {
                    "code": "NSTOP",
                    "codeName": "Server NORMAL STOPPED status"
                },
                "serverInstanceOperation": {
                    "code": "NULL",
                    "codeName": "Server NULL OP"
                },
                "serverInstanceStatusName": "stopped",
                "createDate": "2025-06-11T17:00:14+0900",
                "uptime": "2025-06-19T16:49:07+0900",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "serverProductCode": "SVR.VSVR.CPU.C004.M008.G003",
                "isProtectServerTermination": true,
                "zoneCode": "KR-1",
                "regionCode": "KR",
                "vpcNo": "***75",
                "subnetNo": "****36",
                "networkInterfaceNoList": [
                    "*****30"
                ],
                "serverInstanceType": {
                    "code": "CPU",
                    "codeName": "CPU-Intensive"
                },
                "baseBlockStorageDiskType": {
                    "code": "NET",
                    "codeName": "Network storage"
                },
                "baseBlockStorageDiskDetailType": {
                    "code": "SSD",
                    "codeName": "SSD"
                },
                "hypervisorType": {
                    "code": "KVM",
                    "codeName": "KVM"
                },
                "serverImageNo": "104630229",
                "serverSpecCode": "ci4-g3"
            }
        ],
        "requestId": "a3f0b72c-ed3e-446c-a122-fe2fbd64b6b0",
        "returnCode": "0",
        "returnMessage": "success"
    }
}