Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ProtectedRefs/ Obtaining the List of Protected Branches in a Project

Updated on 2026-01-27 GMT+08:00

View PDF

Obtaining the List of Protected Branches in a Project

Function

This API is used to obtain the protected branch list of a project.

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo::getProjectSetting	Read	-	codeartsrepo:ProjectId	-	-

URI

GET https://{hostURL}/v4/projects/{project_id}/protected-branches

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition You can obtain the unique project identifier, 32-character project UUID, by calling the API used to query the project list. Range String length: 32 characters.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Definition Number of returned records. Value range: 1~100 Default value: 20
search	No	String	Definition: Name of the protected branch Value range: 1–2,000 characters
user_actions	No	Boolean	Definition: Whether to use the return content of the actions permission point. Value range: 1–2,000 characters
view	No	String	Definition: The value can only be simple, indicating that the simple mode is used and only the name is returned. Value range: 1–2,000 characters

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range 1–100,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of ProjectProtectedBranchApiDto objects	Protected branch list of a project

**Table 5** ProjectProtectedBranchApiDto
Parameter	Type	Description
id	Integer	Definition: Unique ID of the protected branch Value range: 1~2147483647
name	String	Definition: Name of the protected branch Value range: 1–1,000 characters.
actions	Array of ProjectProtectedActionResultApiDto objects	Definition: Event list

**Table 6** ProjectProtectedActionResultApiDto
Parameter	Type	Description
action	String	Definition: Event name Value range: 1–1,000 characters.
enable	Boolean	Definition: Enabled or not
users	Array of UserBasicDto objects	Definition: User list
user_teams	Array of UserTeamBasicDto objects	Definition: Member group list
roles	Array of RoleBasicDto objects	Definition: Role list
addition_switchers	Array of ForceActionEnableDto objects	Definition: Operation selection list

**Table 7** UserBasicDto
Parameter	Type	Description
id	Integer	Definition User ID. Value range: 1~2147483647
name	String	Definition Username.
username	String	Definition Username.
state	String	Definition: User status Value range: active: available account blocked: locked user error: The user is not found Enumeration values: active blocked error
service_license_status	Integer	Service-level permission status. 0: disabled; 1: enabled
avatar_url	String	User profile picture URL
avatar_path	String	User profile picture path
email	String	User email
name_cn	String	Username (CN)
web_url	String	User homepage
nick_name	String	User alias
tenant_name	String	Tenant name
error_message	String	Definition When some query APIs detect that the user permission in the transfer parameter is insufficient or the user does not exist, the user is returned but the field is not empty for information.

**Table 8** UserTeamBasicDto
Parameter	Type	Description
id	Integer	Definition: User group ID. Value range: 1–2147483647
name	String	Definition: User group name. Value range: N/A.

**Table 9** RoleBasicDto
Parameter	Type	Description
id	Integer	Definition: Unique role ID Value range: 1~2147483647
name	String	Definition: Role name Value range: 1–1,000 characters.
related_role_id	String	Definition: Role ID Value range: 1–1,000 characters.
chinese_name	String	Definition: Role name (CN) Value range: 1–1,000 characters.

**Table 10** ForceActionEnableDto
Parameter	Type	Description
name	String	Definition: Name of the forced operation Value range: 1–1,000 characters.
enable	Boolean	Definition: Whether to force open this operation.

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

GET https://{endpoint}/v4/projects/3132f98fb2c44430ba68f356af3a8e0d/protected-branches

Example Responses

Status code: 200

Obtain the protected branches of a project

[ {
  "id" : 250,
  "name" : 3,
  "actions" : [ {
    "action" : "push",
    "enable" : true,
    "users" : [ ],
    "user_teams" : [ ],
    "roles" : [ ],
    "addition_switchers" : [ {
      "name" : "allowed_force_push",
      "enable" : false
    } ]
  }, {
    "action" : "merge",
    "enable" : false,
    "users" : null,
    "user_teams" : null,
    "roles" : null,
    "addition_switchers" : null
  } ]
} ]

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
200	Obtain the protected branches of a project
401	Unauthorized
403	Bad Request

Error Codes

See Error Codes.

Parent topic: ProtectedRefs

Previous topic: Deleting a Protected Branch

Next topic: Creating a Protected Branch in a Project

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot