Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Deleting the Deploy Key of a Sub-repository
Updated on 2026-04-28 GMT+08:00

Deleting the Deploy Key of a Sub-repository

Function

This API is used to delete the deploy key of the repository from the submodule.

Debugging

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

URI

DELETE https://{hostURL}/v4/repositories/{repository_id}/deploy-keys/{key_id}/submodules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A.

Value range:

1~2147483647

key_id

Yes

Integer

Definition:

Deploy key ID.

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

Mandatory.

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.

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

DELETE https://{endpoint}/v4/repositories/2112044451/deploy-keys/2112496470/submodules

Example Responses

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

204

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.