Obtaining the Branch List

This API is used to obtain the branch list.

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

GET https://{hostURL}/v4/repositories/{repository_id}/repository/branches

**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_type	No	String	Definition Branch type. By default, all branches are returned. not_protect: unprotected branches are returned. Constraints N/A. Range N/A. Enumeration values: not_protect
creator	No	String	Definition Creator, which can be a user ID or IAM ID. Range 1–100,000 characters.
sort	No	String	Definition Sorting method. Constraints name: branch name in descending order. updated_desc: update time in descending order. updated_asc: update time in ascending order. Default value: updated_desc Enumeration values: name updated_desc updated_asc
query_view	No	String	Definition Branch type. Constraints my_branches: personal branch. active: active branch. stale: outdated branch. all_branches: all branches. Default value: all_branches Enumeration values: my_branches active stale all_branches
view	No	String	Definition Result set attribute. Different results are returned based on the given parameters. Constraints all: returns all branch information. basic: returns basic branch information. simple: returns simple branch information. Enumeration values: simple basic all
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

**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.

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Total	String	Definition Total number of branches.

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of BranchSimpleDto objects	Branch list

**Table 6** BranchSimpleDto
Parameter	Type	Description
name	String	Branch name Value range: 1~100000
default	Boolean	Default branch or not
can_delete	Boolean	Whether user's branch is the default branch
can_read	Boolean	Default branch or not
can_download	Boolean	Default branch or not
can_push	Boolean	Default branch or not

Status code: 401

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

Status code: 403

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

Status code: 404

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

GET https://{endpoint}/v4/repositories/2112015538/repository/branches

Status code: 200

Branch list

[ {
  "name" : "master",
  "default" : true,
  "can_delete" : null,
  "can_read" : null,
  "can_download" : null,
  "can_push" : null
} ]

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

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

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Parent topic: Refs

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.