Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Deleting a Repository Deployment Key
Updated on 2023-09-12 GMT+08:00

Deleting a Repository Deployment Key

Function

Deleting a Repository Deployment Key

URI

DELETE /v2/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

Warehouse Primary Key ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling an 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

Result

status

String

Status code in a response

Table 4 Error

Parameter

Type

Description

code

String

Error Codes

message

String

Error message

Example Requests

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

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.