Querying the Branch of a Warehouse
Function
This API is used to obtain the branch list of a specified repository based on the repository ID.
URI
GET /v1/repositories/{repository_id}/branches
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
repository_id |
Yes |
String |
Primary key ID of a warehouse. |
Request 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. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
Error object |
Response error. |
|
result |
BranchList object |
Result |
|
status |
String |
Status code in a response |
|
Parameter |
Type |
Description |
|---|---|---|
|
branches |
Array of Branch objects |
Branch List of a Specified Repository |
|
total |
Integer |
Total number of branches in a specified repository. |
Example Requests
GET https://{endpoint}/v1/repositories/{repository_id}/branches
Example Responses
Status code: 200
OK
{
"result" : {
"total" : 1,
"branches" : [ {
"name" : "master",
"is_protected" : false
} ]
},
"status" : "success"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
