Obtaining a Repository Branch List
Function
This API is used to obtain a branch list of a repository.
URI
GET /v2/repositories/{repository_id}/branches
Parameter | Mandatory | Type | Description |
|---|---|---|---|
repository_id | Yes | Integer | Repository short ID. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
page | No | String | Page number. |
per_page | No | String | Number of data records on each page. |
match | No | String | Match condition. |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained 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. |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
error | Error object | Response error. |
result | BranchResponse object | Response result. |
status | String | Response status. |
Parameter | Type | Description |
|---|---|---|
branches | Array of BranchesItem objects | Branch information. |
total | Double | Total number. |
Parameter | Type | Description |
|---|---|---|
commit | CommitV2 object | Commit message. |
diverging_commit_counts | DivergingCommitCounts object | Commit discrepancy. |
name | String | Branch name. |
Example Requests
GET https://{endpoint}/v2/repositories/{repository_id}/branches Example Responses
Status code: 200
OK
{
"result" : {
"total" : 1,
"branches" : [ {
"name" : "master",
"commit" : {
"id" : "2912b8f2328e798f7d544272ffaebfccccb598ab",
"title" : "Initial commit",
"message" : "Initial commit",
"committed_date" : "2021-12-06T09:24:50.000+08:00",
"short_id" : "2912b8f2",
"committer_name" : "repo"
},
"diverging_commit_counts" : {
"behind" : 0,
"ahead" : 0
}
} ]
},
"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.
