Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Deleting a Deploy Key
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Deleting a Deploy Key

Function

This API is used to delete a deploy key.

URI

DELETE /v2/repositories/{repository_id}/deploy-keys/{key_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

key_id

Yes

Integer

Explanation:

Deploy key ID, which can be obtained by calling the Adding a Deployment Key API.

Constraints:

N/A

Range:

1–2147483647

Default value:

N/A

repository_id

Yes

Integer

Explanation:

Repository ID.

Constraints:

N/A

Range:

1–2147483647

Default value:

N/A

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding Obtaining a User Token. The value of X-Subject-Token in the response header is the user token.

Constraints:

N/A

Range:

The value is a string of 1–100,000 characters.

Default value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Explanation:

Response error code.

Range:

N/A

result

Boolean

Explanation:

Response result.

Range:

N/A

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

Explanation:

Error code.

Range:

Max. 100 characters in the error code format.

message

String

Explanation:

Error message.

Range:

N/A

Example Requests

DELETE https://{endpoint}/v2/repositories/{repository_id}/deploy-keys/{key_id}

Example Responses

Status code: 200

OK

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

Status Code

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository