Updated on 2026-09-21 GMT+08:00

Unbind an SSH Key Pair

Function

This API is used to unbind an SSH key pair from a specified VM and restore the SSH password login.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/keypairs/disassociate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
server	Yes	DisassociateEcsServerInfo object	Definition Information about the VM to which the key pair is to be bound Constraints N/A Range N/A Default Value N/A

**Table 4** DisassociateEcsServerInfo
Parameter	Mandatory	Type	Description
id	Yes	String	Definition ID of the VM to which the SSH key pair is to be bound (replaced or reset) Constraints N/A Range N/A Default Value N/A
auth	No	Auth object	Definition VM authentication information Constraints Optional. This parameter is required for key pair replacement but not required for key pair reset. Range N/A Default Value N/A

**Table 5** Auth
Parameter	Mandatory	Type	Description
type	No	String	Definition VM authentication type Constraints password: Password authentication is used for the VM. keypair: Key pair authentication is used for the VM. Range N/A Default Value N/A
key	No	String	Definition VM authentication key Constraints If type is set to password, key indicates the password. If type is set to keypair, key indicates the private key. Range N/A Default Value N/A

Response Parameters

Status code: 202

**Table 6** Response body parameters
Parameter	Type	Description
task_id	String	Definition Task ID returned when a task is delivered Range N/A
server_id	String	Definition ID of the bound VM Range N/A
status	String	Definition Task delivery status Range SUCCESS: Task delivered. FAILED: Task delivery failed.
error_code	String	Definition Error code returned when a task fails to be delivered Range N/A
error_msg	String	Definition Error message returned when a task fails to be delivered Range N/A

Example Requests

{
  "server" : {
    "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7",
    "auth" : {
      "type" : "keypair",
      "key" : "-----BEGINRSAPRIVATEKEY-----\nM..."
    }
  }
}

{
  "server" : {
    "id" : "x76baba7-ef09-40a2-87ff-3eafec0696e7"
  }
}

Example Responses

Status code: 202

{
  "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c"
}

Status Codes

Status Code	Description
202	OK

Error Codes

See Error Codes.

Parent Topic: Key pair task management