Help Center/ CodeArts Repo/ API Reference/ Historical APIs/ Adding a Hook to a Specified Repository/ Deleting a Repository Deployment Key (Deprecated)
Updated on 2026-01-27 GMT+08:00

Deleting a Repository Deployment Key (Deprecated)

Function

Delete a repository deployment key.

This API has been discarded. Use the API described in Deleting a Deploy Key from a Repository.

URI

DELETE /v1/repositories/{repository_id}/deploy_keys/{key_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

key_id

Yes

Integer

Deployment key ID

repository_id

Yes

Integer

Repository short ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The user token can be obtained by calling the corresponding IAM API. 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

Boolean

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 codes

message

String

Error message

Request Example

DELETE https://{endpoint}/v1/repositories/{repository_id}/deploy_keys/{key_id}

Response Example

Status code: 200

OK

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

Status Codes

Status Codes

Description

200

OK

Error Codes

See error codes.