How to get details on a GitHub repository using REST API?

Step 1: Create a personal access token in GitHub.

How To Create Personal Access Token In GitHub

Step 2: Get details on a GitHub repository using REST API

## Declare some Variables
GITHUB_PAT_TOKEN='<your_github_personal_access_token>'
GITHUB_REPO_NAME='<your_new_github_repository_name>'
GITHUB_USER_NAME='<your_github_user_name>'

## Get  GitHub repository details in your account
curl \
-H "Authorization: token $GITHUB_PAT_TOKEN" \
https://api.github.com/repos/$GITHUB_USER_NAME/$GITHUB_REPO_NAME

## Returns
## {
##   "id": 501729121,
##   "node_id": "R_kgDOKeSlxw",
##   "name": "debjeet",
##   "full_name": "CloudAffaire/debjeet",
##   "private": true,
##   "owner": {
##     "login": "CloudAffaire",
##     "id": 47243889,
##     "node_id": "MDQ6VXNlcjZ2MjQzNzc5",
##     "avatar_url": "https://avatars.githubusercontent.com/u/47243889?v=4",
##     "gravatar_id": "",
##     "url": "https://api.github.com/users/CloudAffaire",       
##     "html_url": "https://github.com/CloudAffaire",
##     "followers_url": "https://api.github.com/users/CloudAffaire/followers",
##     "following_url": "https://api.github.com/users/CloudAffaire/following{/other_user}",
##     "gists_url": "https://api.github.com/users/CloudAffaire/gists{/gist_id}",
##     "starred_url": "https://api.github.com/users/CloudAffaire/starred{/owner}{/repo}",
##     "subscriptions_url": "https://api.github.com/users/CloudAffaire/subscriptions",
##     "organizations_url": "https://api.github.com/users/CloudAffaire/orgs",
##     "repos_url": "https://api.github.com/users/CloudAffaire/repos",
##     "events_url": "https://api.github.com/users/CloudAffaire/events{/privacy}",
##     "received_events_url": "https://api.github.com/users/CloudAffaire/received_events",
##     "type": "User",
##     "site_admin": false
##   },
##   "html_url": "https://github.com/CloudAffaire/debjeet",      
##   "description": "mycicdpipeline",
##   "fork": false,
##   "url": "https://api.github.com/repos/CloudAffaire/debjeet", 
##   "forks_url": "https://api.github.com/repos/CloudAffaire/debjeet/forks",
##   "keys_url": "https://api.github.com/repos/CloudAffaire/debjeet/keys{/key_id}",
##   "collaborators_url": "https://api.github.com/repos/CloudAffaire/debjeet/collaborators{/collaborator}",
##   "teams_url": "https://api.github.com/repos/CloudAffaire/debjeet/teams",
##   "hooks_url": "https://api.github.com/repos/CloudAffaire/debjeet/hooks",
##   "issue_events_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues/events{/number}",
##   "events_url": "https://api.github.com/repos/CloudAffaire/debjeet/events",
##   "assignees_url": "https://api.github.com/repos/CloudAffaire/debjeet/assignees{/user}",
##   "branches_url": "https://api.github.com/repos/CloudAffaire/debjeet/branches{/branch}",
##   "tags_url": "https://api.github.com/repos/CloudAffaire/debjeet/tags",
##   "blobs_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/blobs{/sha}",
##   "git_tags_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/tags{/sha}",
##   "git_refs_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/refs{/sha}",
##   "trees_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/trees{/sha}",
##   "statuses_url": "https://api.github.com/repos/CloudAffaire/debjeet/statuses/{sha}",
##   "languages_url": "https://api.github.com/repos/CloudAffaire/debjeet/languages",
##   "stargazers_url": "https://api.github.com/repos/CloudAffaire/debjeet/stargazers",
##   "contributors_url": "https://api.github.com/repos/CloudAffaire/debjeet/contributors",
##   "subscribers_url": "https://api.github.com/repos/CloudAffaire/debjeet/subscribers",
##   "subscription_url": "https://api.github.com/repos/CloudAffaire/debjeet/subscription",
##   "commits_url": "https://api.github.com/repos/CloudAffaire/debjeet/commits{/sha}",
##   "git_commits_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/commits{/sha}",
##   "comments_url": "https://api.github.com/repos/CloudAffaire/debjeet/comments{/number}",
##   "issue_comment_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues/comments{/number}",
##   "contents_url": "https://api.github.com/repos/CloudAffaire/debjeet/contents/{+path}",
##   "compare_url": "https://api.github.com/repos/CloudAffaire/debjeet/compare/{base}...{head}",
##   "merges_url": "https://api.github.com/repos/CloudAffaire/debjeet/merges",
##   "archive_url": "https://api.github.com/repos/CloudAffaire/debjeet/{archive_format}{/ref}",
##   "downloads_url": "https://api.github.com/repos/CloudAffaire/debjeet/downloads",
##   "issues_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues{/number}",
##   "pulls_url": "https://api.github.com/repos/CloudAffaire/debjeet/pulls{/number}",
##   "milestones_url": "https://api.github.com/repos/CloudAffaire/debjeet/milestones{/number}",
##   "notifications_url": "https://api.github.com/repos/CloudAffaire/debjeet/notifications{?since,all,participating}",
##   "labels_url": "https://api.github.com/repos/CloudAffaire/debjeet/labels{/name}",
##   "releases_url": "https://api.github.com/repos/CloudAffaire/debjeet/releases{/id}",
##   "deployments_url": "https://api.github.com/repos/CloudAffaire/debjeet/deployments",
##   "created_at": "2022-06-09T06:20:55Z",
##   "updated_at": "2022-06-09T06:20:55Z",
##   "pushed_at": "2022-06-09T06:20:56Z",
##   "git_url": "git://github.com/CloudAffaire/debjeet.git",     
##   "ssh_url": "git@github.com:CloudAffaire/debjeet.git",       
##   "clone_url": "https://github.com/CloudAffaire/debjeet.git", 
##   "svn_url": "https://github.com/CloudAffaire/debjeet",       
##   "homepage": null,
##   "size": 0,
##   "stargazers_count": 0,
##   "watchers_count": 0,
##   "language": null,
##   "has_issues": true,
##   "has_projects": true,
##   "has_downloads": true,
##   "has_wiki": true,
##   "has_pages": false,
##   "forks_count": 0,
##   "mirror_url": null,
##   "archived": false,
##   "disabled": false,
##   "open_issues_count": 0,
##   "license": null,
##   "allow_forking": true,
##   "is_template": false,
##   "topics": [
## 
##   ],
##   "visibility": "private",
##   "forks": 0,
##   "open_issues": 0,
##   "watchers": 0,
##   "default_branch": "main",
##   "permissions": {
##     "admin": true,
##     "maintain": true,
##     "push": true,
##     "triage": true,
##     "pull": true
##   },
##   "allow_squash_merge": true,
##   "allow_merge_commit": true,
##   "allow_rebase_merge": true,
##   "allow_auto_merge": false,
##   "delete_branch_on_merge": false,
##   "allow_update_branch": false,
##   "network_count": 0,
##   "subscribers_count": 1
## }

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

## Declare some Variables

GITHUB_PAT_TOKEN=''

GITHUB_REPO_NAME=''

GITHUB_USER_NAME=''

## Get GitHub repository details in your account

curl \

-H "Authorization: token $GITHUB_PAT_TOKEN" \

https://api.github.com/repos/$GITHUB_USER_NAME/$GITHUB_REPO_NAME

## Returns

## {

## "id": 501729121,

## "node_id": "R_kgDOKeSlxw",

## "name": "debjeet",

## "full_name": "CloudAffaire/debjeet",

## "private": true,

## "owner": {

## "login": "CloudAffaire",

## "id": 47243889,

## "node_id": "MDQ6VXNlcjZ2MjQzNzc5",

## "avatar_url": "https://avatars.githubusercontent.com/u/47243889?v=4",

## "gravatar_id": "",

## "url": "https://api.github.com/users/CloudAffaire",

## "html_url": "https://github.com/CloudAffaire",

## "followers_url": "https://api.github.com/users/CloudAffaire/followers",

## "following_url": "https://api.github.com/users/CloudAffaire/following{/other_user}",

## "gists_url": "https://api.github.com/users/CloudAffaire/gists{/gist_id}",

## "starred_url": "https://api.github.com/users/CloudAffaire/starred{/owner}{/repo}",

## "subscriptions_url": "https://api.github.com/users/CloudAffaire/subscriptions",

## "organizations_url": "https://api.github.com/users/CloudAffaire/orgs",

## "repos_url": "https://api.github.com/users/CloudAffaire/repos",

## "events_url": "https://api.github.com/users/CloudAffaire/events{/privacy}",

## "received_events_url": "https://api.github.com/users/CloudAffaire/received_events",

## "type": "User",

## "site_admin": false

## },

## "html_url": "https://github.com/CloudAffaire/debjeet",

## "description": "mycicdpipeline",

## "fork": false,

## "url": "https://api.github.com/repos/CloudAffaire/debjeet",

## "forks_url": "https://api.github.com/repos/CloudAffaire/debjeet/forks",

## "keys_url": "https://api.github.com/repos/CloudAffaire/debjeet/keys{/key_id}",

## "collaborators_url": "https://api.github.com/repos/CloudAffaire/debjeet/collaborators{/collaborator}",

## "teams_url": "https://api.github.com/repos/CloudAffaire/debjeet/teams",

## "hooks_url": "https://api.github.com/repos/CloudAffaire/debjeet/hooks",

## "issue_events_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues/events{/number}",

## "events_url": "https://api.github.com/repos/CloudAffaire/debjeet/events",

## "assignees_url": "https://api.github.com/repos/CloudAffaire/debjeet/assignees{/user}",

## "branches_url": "https://api.github.com/repos/CloudAffaire/debjeet/branches{/branch}",

## "tags_url": "https://api.github.com/repos/CloudAffaire/debjeet/tags",

## "blobs_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/blobs{/sha}",

## "git_tags_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/tags{/sha}",

## "git_refs_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/refs{/sha}",

## "trees_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/trees{/sha}",

## "statuses_url": "https://api.github.com/repos/CloudAffaire/debjeet/statuses/{sha}",

## "languages_url": "https://api.github.com/repos/CloudAffaire/debjeet/languages",

## "stargazers_url": "https://api.github.com/repos/CloudAffaire/debjeet/stargazers",

## "contributors_url": "https://api.github.com/repos/CloudAffaire/debjeet/contributors",

## "subscribers_url": "https://api.github.com/repos/CloudAffaire/debjeet/subscribers",

## "subscription_url": "https://api.github.com/repos/CloudAffaire/debjeet/subscription",

## "commits_url": "https://api.github.com/repos/CloudAffaire/debjeet/commits{/sha}",

## "git_commits_url": "https://api.github.com/repos/CloudAffaire/debjeet/git/commits{/sha}",

## "comments_url": "https://api.github.com/repos/CloudAffaire/debjeet/comments{/number}",

## "issue_comment_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues/comments{/number}",

## "contents_url": "https://api.github.com/repos/CloudAffaire/debjeet/contents/{+path}",

## "compare_url": "https://api.github.com/repos/CloudAffaire/debjeet/compare/{base}...{head}",

## "merges_url": "https://api.github.com/repos/CloudAffaire/debjeet/merges",

## "archive_url": "https://api.github.com/repos/CloudAffaire/debjeet/{archive_format}{/ref}",

## "downloads_url": "https://api.github.com/repos/CloudAffaire/debjeet/downloads",

## "issues_url": "https://api.github.com/repos/CloudAffaire/debjeet/issues{/number}",

## "pulls_url": "https://api.github.com/repos/CloudAffaire/debjeet/pulls{/number}",

## "milestones_url": "https://api.github.com/repos/CloudAffaire/debjeet/milestones{/number}",

## "notifications_url": "https://api.github.com/repos/CloudAffaire/debjeet/notifications{?since,all,participating}",

## "labels_url": "https://api.github.com/repos/CloudAffaire/debjeet/labels{/name}",

## "releases_url": "https://api.github.com/repos/CloudAffaire/debjeet/releases{/id}",

## "deployments_url": "https://api.github.com/repos/CloudAffaire/debjeet/deployments",

## "created_at": "2022-06-09T06:20:55Z",

## "updated_at": "2022-06-09T06:20:55Z",

## "pushed_at": "2022-06-09T06:20:56Z",

## "git_url": "git://github.com/CloudAffaire/debjeet.git",

## "ssh_url": "git@github.com:CloudAffaire/debjeet.git",

## "clone_url": "https://github.com/CloudAffaire/debjeet.git",

## "svn_url": "https://github.com/CloudAffaire/debjeet",

## "homepage": null,

## "size": 0,

## "stargazers_count": 0,

## "watchers_count": 0,

## "language": null,

## "has_issues": true,

## "has_projects": true,

## "has_downloads": true,

## "has_wiki": true,

## "has_pages": false,

## "forks_count": 0,

## "mirror_url": null,

## "archived": false,

## "disabled": false,

## "open_issues_count": 0,

## "license": null,

## "allow_forking": true,

## "is_template": false,

## "topics": [

## ],

## "visibility": "private",

## "forks": 0,

## "open_issues": 0,

## "watchers": 0,

## "default_branch": "main",

## "permissions": {

## "admin": true,

## "maintain": true,

## "push": true,

## "triage": true,

## "pull": true

## },

## "allow_squash_merge": true,

## "allow_merge_commit": true,

## "allow_rebase_merge": true,

## "allow_auto_merge": false,

## "delete_branch_on_merge": false,

## "allow_update_branch": false,

## "network_count": 0,

## "subscribers_count": 1

## }

To get additional details, please refer to the below documentation.
https://docs.github.com/en/rest/repos

Leave a Reply Cancel reply