List branches
GET
/repos/{owner}/{repo}/branches
repos
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.github.com/repos///branches'
响应示例响应示例
200 - 示例 1
[
{
"commit": {
"sha": "string",
"url": "http://example.com"
},
"name": "string",
"protected": true,
"protection": {
"allow_deletions": {
"enabled": true
},
"allow_force_pushes": {
"enabled": true
},
"enforce_admins": {
"enabled": true,
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins"
},
"name": "\"branch/with/protection\"",
"protection_url": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"",
"required_conversation_resolution": {
"enabled": true
},
"required_linear_history": {
"enabled": true
},
"required_pull_request_reviews": {
"dismiss_stale_reviews": true,
"dismissal_restrictions": {
"teams": [
{
"description": "string",
"html_url": "https://github.com/orgs/rails/teams/core",
"id": 0,
"members_url": "string",
"name": "string",
"node_id": "string",
"parent": {
"description": "A great team.",
"html_url": "https://github.com/orgs/rails/teams/core",
"id": 1,
"ldap_dn": "uid=example,ou=users,dc=github,dc=com",
"members_url": "https://api.github.com/organizations/1/team/1/members{/member}",
"name": "Justice League",
"node_id": "MDQ6VGVhbTE=",
"permission": "admin",
"privacy": "closed",
"repositories_url": "https://api.github.com/organizations/1/team/1/repos",
"slug": "justice-league",
"url": "https://api.github.com/organizations/1/team/1"
},
"permission": "string",
"privacy": "string",
"repositories_url": "http://example.com",
"slug": "string",
"url": "http://example.com"
}
],
"teams_url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"",
"url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"",
"users": [
{
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "41d064eb2195891e12d0413f63227ea7",
"html_url": "https://github.com/octocat",
"id": 1,
"login": "octocat",
"node_id": "MDQ6VXNlcjE=",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": true,
"starred_at": "\"2020-07-09T00:17:55Z\"",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
}
],
"users_url": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\""
},
"require_code_owner_reviews": true,
"required_approving_review_count": 2,
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions"
},
"required_signatures": {
"enabled": true,
"url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures"
},
"required_status_checks": {
"contexts": [
"string"
],
"contexts_url": "string",
"enforcement_level": "string",
"url": "string"
},
"restrictions": {
"apps": [
{
"created_at": "string",
"description": "string",
"events": [
"string"
],
"external_url": "string",
"html_url": "string",
"id": 0,
"name": "string",
"node_id": "string",
"owner": {
"avatar_url": "string",
"description": "string",
"events_url": "string",
"followers_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"",
"following_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"",
"gists_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"",
"gravatar_id": "\"\"",
"hooks_url": "string",
"html_url": "\"https://github.com/testorg-ea8ec76d71c3af4b\"",
"id": 0,
"issues_url": "string",
"login": "string",
"members_url": "string",
"node_id": "string",
"organizations_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"",
"public_members_url": "string",
"received_events_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"",
"repos_url": "string",
"starred_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"",
"subscriptions_url": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"",
"type": "\"Organization\"",
"url": "string"
},
"permissions": {
"contents": "string",
"issues": "string",
"metadata": "string",
"single_file": "string"
},
"slug": "string",
"updated_at": "string"
}
],
"apps_url": "http://example.com",
"teams": [
{
"description": "string",
"html_url": "string",
"id": 0,
"members_url": "string",
"name": "string",
"node_id": "string",
"parent": "string",
"permission": "string",
"privacy": "string",
"repositories_url": "string",
"slug": "string",
"url": "string"
}
],
"teams_url": "http://example.com",
"url": "http://example.com",
"users": [
{
"avatar_url": "string",
"events_url": "string",
"followers_url": "string",
"following_url": "string",
"gists_url": "string",
"gravatar_id": "string",
"html_url": "string",
"id": 0,
"login": "string",
"node_id": "string",
"organizations_url": "string",
"received_events_url": "string",
"repos_url": "string",
"site_admin": true,
"starred_url": "string",
"subscriptions_url": "string",
"type": "string",
"url": "string"
}
],
"users_url": "http://example.com"
},
"url": "string"
},
"protection_url": "http://example.com"
}
]
请求参数
Path 参数
owner
string
必需
repo
string
必需
Query 参数
protected
string
可选
true
returns only protected branches. When set to false
, only unprotected branches are returned. Omitting this parameter returns all branches.per_page
integer
可选
page
integer
可选