github-v3-rest-api

name	github-v3-rest-api
description	GitHub v3 REST API skill. Use when working with GitHub v3 REST for root, admin, app. Covers 682 endpoints.
version	1.0.0
generator	lapsh

GitHub v3 REST API

API version: 1.1.4

Auth

Requires API key (secret parameter)

Base URL

{protocol}://{hostname}/api/v3

Setup

1. Include your API key via the secret parameter
2. GET / -- verify access
3. POST /admin/hooks -- create first hooks

Endpoints

682 endpoints across 36 groups. See references/api-spec.lap for full details.

root

Method	Path	Description
GET	/	GitHub API Root

admin

Method	Path	Description
GET	/admin/hooks	List global webhooks
POST	/admin/hooks	Create a global webhook
GET	/admin/hooks/{hook_id}	Get a global webhook
PATCH	/admin/hooks/{hook_id}	Update a global webhook
DELETE	/admin/hooks/{hook_id}	Delete a global webhook
POST	/admin/hooks/{hook_id}/pings	Ping a global webhook
GET	/admin/keys	List public keys
DELETE	/admin/keys/{key_ids}	Delete a public key
PATCH	/admin/ldap/teams/{team_id}/mapping	Update LDAP mapping for a team
POST	/admin/ldap/teams/{team_id}/sync	Sync LDAP mapping for a team
PATCH	/admin/ldap/users/{username}/mapping	Update LDAP mapping for a user
POST	/admin/ldap/users/{username}/sync	Sync LDAP mapping for a user
POST	/admin/organizations	Create an organization
PATCH	/admin/organizations/{org}	Update an organization name
GET	/admin/pre-receive-environments	List pre-receive environments
POST	/admin/pre-receive-environments	Create a pre-receive environment
GET	/admin/pre-receive-environments/{pre_receive_environment_id}	Get a pre-receive environment
PATCH	/admin/pre-receive-environments/{pre_receive_environment_id}	Update a pre-receive environment
DELETE	/admin/pre-receive-environments/{pre_receive_environment_id}	Delete a pre-receive environment
POST	/admin/pre-receive-environments/{pre_receive_environment_id}/downloads	Start a pre-receive environment download
GET	/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest	Get the download status for a pre-receive environment
GET	/admin/pre-receive-hooks	List pre-receive hooks
POST	/admin/pre-receive-hooks	Create a pre-receive hook
GET	/admin/pre-receive-hooks/{pre_receive_hook_id}	Get a pre-receive hook
PATCH	/admin/pre-receive-hooks/{pre_receive_hook_id}	Update a pre-receive hook
DELETE	/admin/pre-receive-hooks/{pre_receive_hook_id}	Delete a pre-receive hook
GET	/admin/tokens	List personal access tokens
DELETE	/admin/tokens/{token_id}	Delete a personal access token
POST	/admin/users	Create a user
PATCH	/admin/users/{username}	Update the username for a user
DELETE	/admin/users/{username}	Delete a user
POST	/admin/users/{username}/authorizations	Create an impersonation OAuth token
DELETE	/admin/users/{username}/authorizations	Delete an impersonation OAuth token

app

Method	Path	Description
GET	/app	Get the authenticated app
GET	/app/hook/config	Get a webhook configuration for an app
PATCH	/app/hook/config	Update a webhook configuration for an app
GET	/app/installations	List installations for the authenticated app
GET	/app/installations/{installation_id}	Get an installation for the authenticated app
DELETE	/app/installations/{installation_id}	Delete an installation for the authenticated app
POST	/app/installations/{installation_id}/access_tokens	Create an installation access token for an app
PUT	/app/installations/{installation_id}/suspended	Suspend an app installation
DELETE	/app/installations/{installation_id}/suspended	Unsuspend an app installation

app-manifests

Method	Path	Description
POST	/app-manifests/{code}/conversions	Create a GitHub App from a manifest

applications

Method	Path	Description
GET	/applications/grants	List your grants
GET	/applications/grants/{grant_id}	Get a single grant
DELETE	/applications/grants/{grant_id}	Delete a grant
DELETE	/applications/{client_id}/grant	Delete an app authorization
DELETE	/applications/{client_id}/grants/{access_token}	Revoke a grant for an application
POST	/applications/{client_id}/token	Check a token
PATCH	/applications/{client_id}/token	Reset a token
DELETE	/applications/{client_id}/token	Delete an app token
POST	/applications/{client_id}/token/scoped	Create a scoped access token
GET	/applications/{client_id}/tokens/{access_token}	Check an authorization
POST	/applications/{client_id}/tokens/{access_token}	Reset an authorization
DELETE	/applications/{client_id}/tokens/{access_token}	Revoke an authorization for an application

apps

Method	Path	Description
GET	/apps/{app_slug}	Get an app

authorizations

Method	Path	Description
GET	/authorizations	List your authorizations
POST	/authorizations	Create a new authorization
PUT	/authorizations/clients/{client_id}	Get-or-create an authorization for a specific app
PUT	/authorizations/clients/{client_id}/{fingerprint}	Get-or-create an authorization for a specific app and fingerprint
GET	/authorizations/{authorization_id}	Get a single authorization
PATCH	/authorizations/{authorization_id}	Update an existing authorization
DELETE	/authorizations/{authorization_id}	Delete an authorization

codes_of_conduct

Method	Path	Description
GET	/codes_of_conduct	Get all codes of conduct
GET	/codes_of_conduct/{key}	Get a code of conduct

emojis

Method	Path	Description
GET	/emojis	Get emojis

enterprise

Method	Path	Description
GET	/enterprise/announcement	Get the global announcement banner
PATCH	/enterprise/announcement	Set the global announcement banner
DELETE	/enterprise/announcement	Remove the global announcement banner
GET	/enterprise/settings/license	Get license information
GET	/enterprise/stats/all	Get all statistics
GET	/enterprise/stats/comments	Get comment statistics
GET	/enterprise/stats/gists	Get gist statistics
GET	/enterprise/stats/hooks	Get hooks statistics
GET	/enterprise/stats/issues	Get issue statistics
GET	/enterprise/stats/milestones	Get milestone statistics
GET	/enterprise/stats/orgs	Get organization statistics
GET	/enterprise/stats/pages	Get pages statistics
GET	/enterprise/stats/pulls	Get pull request statistics
GET	/enterprise/stats/repos	Get repository statistics
GET	/enterprise/stats/users	Get users statistics

enterprises

Method	Path	Description
GET	/enterprises/{enterprise}/actions/permissions	Get GitHub Actions permissions for an enterprise
PUT	/enterprises/{enterprise}/actions/permissions	Set GitHub Actions permissions for an enterprise
GET	/enterprises/{enterprise}/actions/permissions/organizations	List selected organizations enabled for GitHub Actions in an enterprise
PUT	/enterprises/{enterprise}/actions/permissions/organizations	Set selected organizations enabled for GitHub Actions in an enterprise
PUT	/enterprises/{enterprise}/actions/permissions/organizations/{org_id}	Enable a selected organization for GitHub Actions in an enterprise
DELETE	/enterprises/{enterprise}/actions/permissions/organizations/{org_id}	Disable a selected organization for GitHub Actions in an enterprise
GET	/enterprises/{enterprise}/actions/permissions/selected-actions	Get allowed actions for an enterprise
PUT	/enterprises/{enterprise}/actions/permissions/selected-actions	Set allowed actions for an enterprise
GET	/enterprises/{enterprise}/actions/runner-groups	List self-hosted runner groups for an enterprise
POST	/enterprises/{enterprise}/actions/runner-groups	Create a self-hosted runner group for an enterprise
GET	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}	Get a self-hosted runner group for an enterprise
PATCH	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}	Update a self-hosted runner group for an enterprise
DELETE	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}	Delete a self-hosted runner group from an enterprise
GET	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations	List organization access to a self-hosted runner group in an enterprise
PUT	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations	Set organization access for a self-hosted runner group in an enterprise
PUT	/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}

events

Method	Path	Description
GET	/events	List public events

feeds

Method	Path	Description
GET	/feeds	Get feeds

gists

Method	Path	Description
GET	/gists	List gists for the authenticated user
POST	/gists	Create a gist
GET	/gists/public	List public gists
GET	/gists/starred	List starred gists
GET	/gists/{gist_id}	Get a gist
PATCH	/gists/{gist_id}	Update a gist
DELETE	/gists/{gist_id}	Delete a gist
GET	/gists/{gist_id}/comments	List gist comments
POST	/gists/{gist_id}/comments	Create a gist comment
GET	/gists/{gist_id}/comments/{comment_id}	Get a gist comment
PATCH	/gists/{gist_id}/comments/{comment_id}	Update a gist comment
DELETE	/gists/{gist_id}/comments/{comment_id}	Delete a gist comment
GET	/gists/{gist_id}/commits	List gist commits
GET	/gists/{gist_id}/forks	List gist forks
POST	/gists/{gist_id}/forks	Fork a gist
GET	/gists/{gist_id}/star	Check if a gist is starred
PUT	/gists/{gist_id}/star	Star a gist
DELETE	/gists/{gist_id}/star	Unstar a gist
GET	/gists/{gist_id}/{sha}	Get a gist revision

gitignore

Method	Path	Description
GET	/gitignore/templates	Get all gitignore templates
GET	/gitignore/templates/{name}	Get a gitignore template

installation

Method	Path	Description
GET	/installation/repositories	List repositories accessible to the app installation
DELETE	/installation/token	Revoke an installation access token

issues

Method	Path	Description
GET	/issues	List issues assigned to the authenticated user

licenses

Method	Path	Description
GET	/licenses	Get all commonly used licenses
GET	/licenses/{license}	Get a license

markdown

Method	Path	Description
POST	/markdown	Render a Markdown document
POST	/markdown/raw	Render a Markdown document in raw mode

meta

Method	Path	Description
GET	/meta	Get GitHub Enterprise Server meta information

networks

Method	Path	Description
GET	/networks/{owner}/{repo}/events	List public events for a network of repositories

notifications

Method	Path	Description
GET	/notifications	List notifications for the authenticated user
PUT	/notifications	Mark notifications as read
GET	/notifications/threads/{thread_id}	Get a thread
PATCH	/notifications/threads/{thread_id}	Mark a thread as read
GET	/notifications/threads/{thread_id}/subscription	Get a thread subscription for the authenticated user
PUT	/notifications/threads/{thread_id}/subscription	Set a thread subscription
DELETE	/notifications/threads/{thread_id}/subscription	Delete a thread subscription

octocat

Method	Path	Description
GET	/octocat	Get Octocat

organizations

Method	Path	Description
GET	/organizations	List organizations

orgs

Method	Path	Description
GET	/orgs/{org}	Get an organization
PATCH	/orgs/{org}	Update an organization
GET	/orgs/{org}/actions/permissions	Get GitHub Actions permissions for an organization
PUT	/orgs/{org}/actions/permissions	Set GitHub Actions permissions for an organization
GET	/orgs/{org}/actions/permissions/repositories	List selected repositories enabled for GitHub Actions in an organization
PUT	/orgs/{org}/actions/permissions/repositories	Set selected repositories enabled for GitHub Actions in an organization
PUT	/orgs/{org}/actions/permissions/repositories/{repository_id}	Enable a selected repository for GitHub Actions in an organization
DELETE	/orgs/{org}/actions/permissions/repositories/{repository_id}	Disable a selected repository for GitHub Actions in an organization
GET	/orgs/{org}/actions/permissions/selected-actions	Get allowed actions for an organization
PUT	/orgs/{org}/actions/permissions/selected-actions	Set allowed actions for an organization
GET	/orgs/{org}/actions/runner-groups	List self-hosted runner groups for an organization
POST	/orgs/{org}/actions/runner-groups	Create a self-hosted runner group for an organization
GET	/orgs/{org}/actions/runner-groups/{runner_group_id}	Get a self-hosted runner group for an organization
PATCH	/orgs/{org}/actions/runner-groups/{runner_group_id}	Update a self-hosted runner group for an organization
DELETE	/orgs/{org}/actions/runner-groups/{runner_group_id}	Delete a self-hosted runner group from an organization
GET	/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories	List repository access to a self-hosted runner group in an organization
PUT	/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories	Set repository access for a self-hosted runner group in an organization
PUT

projects

Method	Path	Description
GET	/projects/columns/cards/{card_id}	Get a project card
PATCH	/projects/columns/cards/{card_id}	Update an existing project card
DELETE	/projects/columns/cards/{card_id}	Delete a project card
POST	/projects/columns/cards/{card_id}/moves	Move a project card
GET	/projects/columns/{column_id}	Get a project column
PATCH	/projects/columns/{column_id}	Update an existing project column
DELETE	/projects/columns/{column_id}	Delete a project column
GET	/projects/columns/{column_id}/cards	List project cards
POST	/projects/columns/{column_id}/cards	Create a project card
POST	/projects/columns/{column_id}/moves	Move a project column
GET	/projects/{project_id}	Get a project
PATCH	/projects/{project_id}	Update a project
DELETE	/projects/{project_id}	Delete a project
GET	/projects/{project_id}/collaborators	List project collaborators
PUT	/projects/{project_id}/collaborators/{username}	Add project collaborator
DELETE	/projects/{project_id}/collaborators/{username}	Remove user as a collaborator
GET	/projects/{project_id}/collaborators/{username}/permission	Get project permission for a user
GET	/projects/{project_id}/columns	List project columns
POST	/projects/{project_id}/columns	Create a project column

rate_limit

Method	Path	Description
GET	/rate_limit	Get rate limit status for the authenticated user

reactions

Method	Path	Description
DELETE	/reactions/{reaction_id}	Delete a reaction (Legacy)

repos

Method	Path	Description
GET	/repos/{owner}/{repo}	Get a repository
PATCH	/repos/{owner}/{repo}	Update a repository
DELETE	/repos/{owner}/{repo}	Delete a repository
GET	/repos/{owner}/{repo}/actions/artifacts	List artifacts for a repository
GET	/repos/{owner}/{repo}/actions/artifacts/{artifact_id}	Get an artifact
DELETE	/repos/{owner}/{repo}/actions/artifacts/{artifact_id}	Delete an artifact
GET	/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}	Download an artifact
GET	/repos/{owner}/{repo}/actions/jobs/{job_id}	Get a job for a workflow run
GET	/repos/{owner}/{repo}/actions/jobs/{job_id}/logs	Download job logs for a workflow run
GET	/repos/{owner}/{repo}/actions/permissions	Get GitHub Actions permissions for a repository
PUT	/repos/{owner}/{repo}/actions/permissions	Set GitHub Actions permissions for a repository
GET	/repos/{owner}/{repo}/actions/permissions/selected-actions	Get allowed actions for a repository
PUT	/repos/{owner}/{repo}/actions/permissions/selected-actions	Set allowed actions for a repository
GET	/repos/{owner}/{repo}/actions/runners	List self-hosted runners for a repository
GET	/repos/{owner}/{repo}/actions/runners/downloads	List runner applications for a repository
POST	/repos/{owner}/{repo}/actions/runners/registration-token	Create a registration token for a repository
POST	/repos/{owner}/{repo}/actions/runners/remove-token	Create a remove token for a repository
GET	/repos/{owner}/{repo}/actions/runners/{runner_id}	Get a self-hosted runner for a repository
DELETE	/repos/{owner}/{repo}/actions/runners/{runner_id}	Delete a self-hosted runner from a repository
GET

repositories

Method	Path	Description
GET	/repositories	List public repositories

search

Method	Path	Description
GET	/search/code	Search code
GET	/search/commits	Search commits
GET	/search/issues	Search issues and pull requests
GET	/search/labels	Search labels
GET	/search/repositories	Search repositories
GET	/search/topics	Search topics
GET	/search/users	Search users

setup

Method	Path	Description
GET	/setup/api/configcheck	Get the configuration status
POST	/setup/api/configure	Start a configuration process
GET	/setup/api/maintenance	Get the maintenance status
POST	/setup/api/maintenance	Enable or disable maintenance mode
GET	/setup/api/settings	Get settings
PUT	/setup/api/settings	Set settings
GET	/setup/api/settings/authorized-keys	Get all authorized SSH keys
POST	/setup/api/settings/authorized-keys	Add an authorized SSH key
DELETE	/setup/api/settings/authorized-keys	Remove an authorized SSH key
POST	/setup/api/start	Create a GitHub license
POST	/setup/api/upgrade	Upgrade a license

teams

Method	Path	Description
GET	/teams/{team_id}	Get a team (Legacy)
PATCH	/teams/{team_id}	Update a team (Legacy)
DELETE	/teams/{team_id}	Delete a team (Legacy)
GET	/teams/{team_id}/discussions	List discussions (Legacy)
POST	/teams/{team_id}/discussions	Create a discussion (Legacy)
GET	/teams/{team_id}/discussions/{discussion_number}	Get a discussion (Legacy)
PATCH	/teams/{team_id}/discussions/{discussion_number}	Update a discussion (Legacy)
DELETE	/teams/{team_id}/discussions/{discussion_number}	Delete a discussion (Legacy)
GET	/teams/{team_id}/discussions/{discussion_number}/comments	List discussion comments (Legacy)
POST	/teams/{team_id}/discussions/{discussion_number}/comments	Create a discussion comment (Legacy)
GET	/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}	Get a discussion comment (Legacy)
PATCH	/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}	Update a discussion comment (Legacy)
DELETE	/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}	Delete a discussion comment (Legacy)
GET	/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions	List reactions for a team discussion comment (Legacy)
POST	/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions	Create reaction for a team discussion comment (Legacy)
GET	/teams/{team_id}/discussions/{discussion_number}/reactions	List reactions for a team discussion (Legacy)
POST	/teams/{team_id}/discussions/{discussion_number}/reactions	Create reaction for a team discussion (Legacy)
GET	/teams/{team_id}/members	List team members (Legacy)
GET	/teams/{team_id}/members/{username}

user

Method	Path	Description
GET	/user	Get the authenticated user
PATCH	/user	Update the authenticated user
GET	/user/emails	List email addresses for the authenticated user
POST	/user/emails	Add an email address for the authenticated user
DELETE	/user/emails	Delete an email address for the authenticated user
GET	/user/followers	List followers of the authenticated user
GET	/user/following	List the people the authenticated user follows
GET	/user/following/{username}	Check if a person is followed by the authenticated user
PUT	/user/following/{username}	Follow a user
DELETE	/user/following/{username}	Unfollow a user
GET	/user/gpg_keys	List GPG keys for the authenticated user
POST	/user/gpg_keys	Create a GPG key for the authenticated user
GET	/user/gpg_keys/{gpg_key_id}	Get a GPG key for the authenticated user
DELETE	/user/gpg_keys/{gpg_key_id}	Delete a GPG key for the authenticated user
GET	/user/installations	List app installations accessible to the user access token
GET	/user/installations/{installation_id}/repositories	List repositories accessible to the user access token
PUT	/user/installations/{installation_id}/repositories/{repository_id}	Add a repository to an app installation
DELETE	/user/installations/{installation_id}/repositories/{repository_id}	Remove a repository from an app installation
GET	/user/issues	List user account issues assigned to the authenticated user
GET	/user/keys	List public SSH keys for the authenticated user
POST	/user/keys	Create a public SSH key for the authenticated user

users

Method	Path	Description
GET	/users	List users
GET	/users/{username}	Get a user
GET	/users/{username}/events	List events for the authenticated user
GET	/users/{username}/events/orgs/{org}	List organization events for the authenticated user
GET	/users/{username}/events/public	List public events for a user
GET	/users/{username}/followers	List followers of a user
GET	/users/{username}/following	List the people a user follows
GET	/users/{username}/following/{target_user}	Check if a user follows another user
GET	/users/{username}/gists	List gists for a user
GET	/users/{username}/gpg_keys	List GPG keys for a user
GET	/users/{username}/hovercard	Get contextual information for a user
GET	/users/{username}/installation	Get a user installation for the authenticated app
GET	/users/{username}/keys	List public keys for a user
GET	/users/{username}/orgs	List organizations for a user
GET	/users/{username}/projects	List user projects
GET	/users/{username}/received_events	List events received by the authenticated user
GET	/users/{username}/received_events/public	List public events received by a user
GET	/users/{username}/repos	List repositories for a user
PUT	/users/{username}/site_admin	Promote a user to be a site administrator
DELETE	/users/{username}/site_admin	Demote a site administrator
GET	/users/{username}/starred	List repositories starred by a user
GET	/users/{username}/subscriptions	List repositories watched by a user

zen

Method	Path	Description
GET	/zen	Get the Zen of GitHub

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all hooks?" -> GET /admin/hooks
• "Create a hook?" -> POST /admin/hooks
• "Get hook details?" -> GET /admin/hooks/{hook_id}
• "Partially update a hook?" -> PATCH /admin/hooks/{hook_id}
• "Delete a hook?" -> DELETE /admin/hooks/{hook_id}
• "Create a ping?" -> POST /admin/hooks/{hook_id}/pings
• "List all keys?" -> GET /admin/keys
• "Delete a key?" -> DELETE /admin/keys/{key_ids}
• "Create a sync?" -> POST /admin/ldap/teams/{team_id}/sync
• "Create a sync?" -> POST /admin/ldap/users/{username}/sync
• "Create a organization?" -> POST /admin/organizations
• "Partially update a organization?" -> PATCH /admin/organizations/{org}
• "List all pre-receive-environments?" -> GET /admin/pre-receive-environments
• "Create a pre-receive-environment?" -> POST /admin/pre-receive-environments
• "Get pre-receive-environment details?" -> GET /admin/pre-receive-environments/{pre_receive_environment_id}
• "Partially update a pre-receive-environment?" -> PATCH /admin/pre-receive-environments/{pre_receive_environment_id}
• "Delete a pre-receive-environment?" -> DELETE /admin/pre-receive-environments/{pre_receive_environment_id}
• "Create a download?" -> POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads
• "List all latest?" -> GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest
• "List all pre-receive-hooks?" -> GET /admin/pre-receive-hooks
• "Create a pre-receive-hook?" -> POST /admin/pre-receive-hooks
• "Get pre-receive-hook details?" -> GET /admin/pre-receive-hooks/{pre_receive_hook_id}
• "Partially update a pre-receive-hook?" -> PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}
• "Delete a pre-receive-hook?" -> DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}
• "List all tokens?" -> GET /admin/tokens
• "Delete a token?" -> DELETE /admin/tokens/{token_id}
• "Create a user?" -> POST /admin/users
• "Partially update a user?" -> PATCH /admin/users/{username}
• "Delete a user?" -> DELETE /admin/users/{username}
• "Create a authorization?" -> POST /admin/users/{username}/authorizations
• "List all app?" -> GET /app
• "Create a conversion?" -> POST /app-manifests/{code}/conversions
• "List all config?" -> GET /app/hook/config
• "List all installations?" -> GET /app/installations
• "Get installation details?" -> GET /app/installations/{installation_id}
• "Delete a installation?" -> DELETE /app/installations/{installation_id}
• "Create a access_token?" -> POST /app/installations/{installation_id}/access_tokens