Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ProtectedRefs/ Deleting a Protected Branch
Updated on 2026-04-28 GMT+08:00

Deleting a Protected Branch

Function

This API is used to delete a protected branch.

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}/protected-branch

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

branch_name

Yes

String

Definition:

Protected branch name or wildcard list.

Request Parameters

Table 3 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

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Status code

  • success: The API request is successful.

  • fail: The API request failed.

Enumeration values:

  • success

  • fail

Example Requests

None

Example Responses

Status code: 204

OK

{
  "status" : "success"
}

Status Codes

Status Code

Description

204

OK

Error Codes

See Error Codes.