Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ User/ Deleting an SSH Public Key
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Deleting an SSH Public Key

Function

This API is used to delete an SSH public key.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::updateUserSetting

Write

-

-

-

-

URI

DELETE https://{hostURL}/v4/user/keys/{key_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

key_id

Yes

Integer

Definition

Resource ID, which is the ID in the data obtained from the API for obtaining the repository group permission resource point list.

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 204

OK

Status code: 401

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

DELETE https://{endpoint}/v4/user/keys/{key_id}

Example Responses

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

204

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: User