Available in VPC
Delete an authentication key. However, you can't delete authentication keys that are assigned a launch configuration for a server instance or Auto Scaling service.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | POST | /vserver/v2/deleteLoginKeys |
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
|
keyNameList.N |
Array | Required | Authentication key list
|
responseFormatType |
String | Optional | Format of the response data
|
Request example
The request example is as follows:
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/deleteLoginKeys
?regionCode=KR
&keyNameList.1=test-***
&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 |
|---|---|---|---|
deleteLoginKeysResponse |
Object | - | Response result
|
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:
{
"deleteLoginKeysResponse": {
"requestId": "d046cdda-ca4b-435a-8a06-fbc9795b3548",
"returnCode": "0",
"returnMessage": "success"
}
}