Obtaining Protected Branch List of a Repository Group

Function

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

Debugging

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

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET https://{hostURL}/v4/groups/{group_id}/protected-branches

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
group_id	Yes	Integer	Definition Repository group ID, which is the numeric ID next to Group ID on the repository group homepage. Default Value N/A Value range: 1~2147483647

**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 Search for content. Constraints Name of the protected branch. Range Name of the protected branch. Default Value N/A Default value: false
user_actions	Yes	Boolean	Definition Whether to return data with the user_action structure. The user_action structure is the latest structure. It is recommended that this parameter be transferred to true. Constraints true,false Range true,false Default Value No parameter is transferred by default. Default value: false

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token 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. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of GroupProtectedBranchApiDto objects	Definition Protected branch list of a repository group. Constraints N/A Range N/A Default Value N/A

**Table 5** GroupProtectedBranchApiDto
Parameter	Type	Description
id	Integer	Definition Unique ID of the protected branch. Constraints N/A Range N/A Default Value N/A Value range: 1~2147483647
name	String	Definition Name of the protected branch. Range The value must contain 1 to 1,000 characters. Constraints N/A Default Value N/A
actions	Array of ProjectProtectedActionResultApiDto objects	Definition Event list. Constraints N/A Range N/A Default Value N/A
namespace_id	Integer	Definition Repository group ID. Constraints N/A Range N/A Default Value N/A Value range: 1~2147483647

**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/groups/{group_id}/protected-branches

Example Responses

Status code: 202

Obtain the protected branch list of a repository group.

[ {
  "id" : 250,
  "name" : 3,
  "namespace_id" : 2111955766,
  "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
202	Obtain the protected branch list of a repository group.
401	Unauthorized
403	Bad Request

Error Codes

See Error Codes.

Parent topic: Group

Previous topic: Obtaining the Inheritance Settings of a Repository Group

Next topic: Creating a Repository Group

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.

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

Chatbot