Summary - GitHub API

Combine API parts to set up an automated flow.

Automation with the GitHub API

The GitHub REST API can automate tasks such as retrieving repository information, authenticating a user, and managing organization resources. A script can run these operations in sequence to reduce repetitive work.

GET /user
GET /repos/{owner}/{repo}
GET /orgs/{org}/teams

Requests that require authentication use a token. Token permissions should cover only the operations that need to be performed.

Exercise Create an authenticated API workflow

Use the GITHUB_TOKEN variable to send a GET request first to the GitHub user endpoint and then to the teams endpoint of the my-company organization. Use Bearer authentication and a JSON Accept header in both requests. Print the HTTP status code for each request.

Show example solution

curl -sS -o /dev/null -w "%{http_code}\n" -X GET -H "Authorization: Bearer $GITHUB_TOKEN" -H "Accept: application/vnd.github+json" https://api.github.com/user
curl -sS -o /dev/null -w "%{http_code}\n" -X GET -H "Authorization: Bearer $GITHUB_TOKEN" -H "Accept: application/vnd.github+json" https://api.github.com/orgs/my-company/teams

Test yourself

An automation script must first authenticate a user with a token and then list an organization's teams. Which approach is suitable?
- Run only local Git commands
- Sequence REST API requests with an Authorization header
- Manually use a browser for every operation
- Clone the repository again
Show answer

Sequence REST API requests with an Authorization header — REST API requests can authenticate with a token in the Authorization header to create an automated workflow.

Complete authentication for the automation request

curl -H "Authorization: Bearer $GITHUB_TOKEN" -H "Accept: application/vnd.github+json" https://api.github.com/user____

Show answer

curl -H "Authorization: Bearer $GITHUB_TOKEN" -H "Accept: application/vnd.github+json" https://api.github.com/userAccept

Parts of a GitHub API workflow

REST API

Accesses resources over HTTP
Token

Carries authentication credentials
Organization

Groups members and teams
Automation

Runs repetitive requests automatically

Next lesson: GPG signing

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies