cvm · 2017-03-12

DeleteKeyPairs

POST

Delete hosted key pairs.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/DeleteKeyPairs path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl

curl -sS https://cvm.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: cvm.api3.convergecloud.com' \
  -H 'X-TC-Action: DeleteKeyPairs' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"KeyIds":["<KeyId>"]}'

Request parameters

Field	Type	Required	Description
KeyIds	string[]	Yes	One or more key pair IDs to be operated. The maximum number of key pairs per request is 100. You can obtain an available key pair ID in the following ways: Log in to the console to query the key pair ID. Call the DescribeKeyPairs API and obtain the key pair ID from the `KeyId` in the response.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

Field	Type	Description
RequestId	string	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Success

{
  "Response": {
    // action-specific fields,
    "RequestId": "…"
  }
}

Error

{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.

SecretIdSecretKey

Request bodyvalid JSONPOST cvm.api3.convergecloud.com · DeleteKeyPairs

{
  "KeyIds": [
    "<KeyId>"
  ]
}

This action changes resources in my own account and may create a charge. I understand.

Recorded example response — captured 2026-09-16

{
  "Response": {
    "RequestId": "ebdf46f8-1f8e-ee71-e2e9-55dcb4984253"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1

{
  "Response": {
    "Error": {
      "Code": "InvalidKeyPairId.Malformed",
      "Message": "The specified key pair ID `.KeyIds` `skp-00000000` is malformed. Ensure that you provide the full key pair ID in the request, in the form skey-xxxxxxxx.The letter `x` stands for lowercase letter or number."
    },
    "RequestId": "d25778aa-b246-c43a-dd65-ffe16bef00ab"
  }
}

Recorded error 2

{
  "Response": {
    "Error": {
      "Code": "InvalidKeyPairId.Malformed",
      "Message": "The specified key pair ID `.KeyIds` `skp-00000000` is malformed. Ensure that you provide the full key pair ID in the request, in the form skey-xxxxxxxx.The letter `x` stands for lowercase letter or number."
    },
    "RequestId": "11fc5c41-6b0e-45e9-9084-9e0ec93f15d6"
  }
}