Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Deleting a Protected Branch
Updated on 2025-05-15 GMT+08:00
View PDF

Deleting a Protected Branch

Function

This API is used to delete a protected branch.

URI

DELETE /v2/repositories/{repository_id}/protected-branches/{branch_name}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Repository primary key ID.

branch_name

Yes

String

Branch name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. 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

String

Response result.

status

String

Response status.
Table 4 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

Example Requests

DELETE https://{endpoint}/v2/repositories//{repository_id}/protected_branches/{branch_name}

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository