ownerstringrequired
repostringrequired
refstringrequired
Download a repository archive (tar)
Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually
master) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the Location header to make a second GET request.
Note: For private repositories, these links are temporary and expire after five minutes.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/tarball/{ref}
Path Parameters
Response
302
Response
302
Response
get/repos/{owner}/{repo}/tarball/{ref}
Path Parameters
302
List repository teams
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/teams
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
Response
200 application/json
Response
200 application/json
Response
Groups of organization members that gives permissions on specified repositories.
idintegerrequired
node_idstringrequired
namestringrequired
slugstringrequired
descriptionstring | nullrequired
privacystring
permissionstringrequired
permissionsobject
Show Child Parameters
urlstring(uri)required
html_urlstring(uri)required
Example:https://github.com/orgs/rails/teams/core
members_urlstringrequired
repositories_urlstring(uri)required
parentobject | nullrequired
Groups of organization members that gives permissions on specified repositories.
Show Child Parameters
get/repos/{owner}/{repo}/teams
Path Parameters
Query Parameters
200 application/json
Get all repository topics
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/topics
Query Parameters
pageinteger
Page number of the results to fetch.
Default:1
per_pageinteger
Results per page (max 100)
Default:30
Path Parameters
ownerstringrequired
repostringrequired
Response
application/json
Response
application/json
Response
Topic
A topic aggregates entities that are related to a subject.
namesarray[string]required
get/repos/{owner}/{repo}/topics
Path Parameters
Query Parameters
application/json
Replace all repository topics
put
http://HOSTNAME/api/v3/repos/{owner}/{repo}/topics
Path Parameters
ownerstringrequired
repostringrequired
Body
application/json
Body
application/json
namesarray[string]required
An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.
Response
application/json
Response
application/json
Response
Topic
A topic aggregates entities that are related to a subject.
namesarray[string]required
put/repos/{owner}/{repo}/topics
Path Parameters
Body
{
"names": [
"octocat",
"atom",
"electron",
"api"
]
}
application/json
Transfer a repository
A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/transfer
Path Parameters
ownerstringrequired
repostringrequired
Body
application/json
Body
application/json
new_ownerstringrequired
The username or organization name the repository will be transferred to.
team_idsarray[integer]
ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.
Response
202 application/json
Response
202 application/json
Response
Minimal Repository
Minimal Repository
idintegerrequired
Example:1296269
node_idstringrequired
Example:MDEwOlJlcG9zaXRvcnkxMjk2MjY5
namestringrequired
Example:Hello-World
full_namestringrequired
Example:octocat/Hello-World
ownerobjectrequired
Simple User
Show Child Parameters
privatebooleanrequired
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World
descriptionstring | nullrequired
Example:This your first repo!
forkbooleanrequired
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World
archive_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/contributors
deployments_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/deployments
downloads_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/downloads
events_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/events
forks_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/forks
git_commits_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_urlstring
issue_comment_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/languages
merges_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/merges
milestones_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_urlstring
stargazers_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/subscription
tags_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/tags
teams_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/teams
trees_urlstringrequired
Example:http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_urlstring
mirror_urlstring | null
hooks_urlstring(uri)required
Example:http://api.github.com/repos/octocat/Hello-World/hooks
svn_urlstring
homepagestring | null
languagestring | null
forks_countinteger
stargazers_countinteger
watchers_countinteger
sizeinteger
default_branchstring
open_issues_countinteger
is_templateboolean
topicsarray[string]
has_issuesboolean
has_projectsboolean
has_wikiboolean
has_pagesboolean
has_downloadsboolean
archivedboolean
disabledboolean
visibilitystring
pushed_atstring | null(date-time)
Example:2011-01-26T19:06:43Z
created_atstring | null(date-time)
Example:2011-01-26T19:01:12Z
updated_atstring | null(date-time)
Example:2011-01-26T19:14:43Z
permissionsobject
Show Child Parameters
template_repositoryobject | null
A git repository
Show Child Parameters
temp_clone_tokenstring
delete_branch_on_mergeboolean
subscribers_countinteger
network_countinteger
code_of_conductobject
Code Of Conduct
Show Child Parameters
licenseobject | null
Show Child Parameters
forksinteger
Example:0
open_issuesinteger
Example:0
watchersinteger
Example:0
allow_forkingboolean
post/repos/{owner}/{repo}/transfer
Path Parameters
Body
{
"new_owner": "github",
"team_ids": [
12,
345
]
}
202 application/json