Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Querying the Branch of a Warehouse

Updated on 2023-09-12 GMT+08:00

View PDF

Querying the Branch of a Warehouse

This API is used to obtain the branch list of a specified repository based on the repository ID.

GET /v1/repositories/{repository_id}/branches

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	String	Primary key ID of a warehouse.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Status code: 200

**Table 4** Error
Parameter	Type	Description
code	String	Error Codes
message	String	Error message

**Table 5** BranchList
Parameter	Type	Description
branches	Array of Branch objects	Branch List of a Specified Repository
total	Integer	Total number of branches in a specified repository.

**Table 6** Branch
Parameter	Type	Description
is_protected	Boolean	Whether to enable the branch protection function
name	String	Branch Name

GET https://{endpoint}/v1/repositories/{repository_id}/branches

Status code: 200

{
  "result" : {
    "total" : 1,
    "branches" : [ {
      "name" : "master",
      "is_protected" : false
    } ]
  },
  "status" : "success"
}

Status Code	Description
200	OK

Parent topic: Repository

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.