Help Center/ CodeArts Repo/ API Reference/ Historical APIs/ SSH Key/ Deleting a User Public Key (Deprecated)
Updated on 2026-01-27 GMT+08:00

Deleting a User Public Key (Deprecated)

Function

This API is used to delete a user public key.

This API has been deprecated.

URI

DELETE /v1/users/sshkey/{id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

id

Yes

String

SSH key ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

result

String

Response result.

status

String

Explanation:

Response status

Range:

  • success: The API call is successful.
  • failed: The API call failed.
Table 4 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

Example Requests

DELETE https://{endpoint}/v1/users/sshkey/{id}

Example Responses

Status code: 200

OK

{
  "result" : "1034531",
  "status" : "success"
}

Status Code

Status Code

Description

200

OK

Error code.

See error codes.