Available Endpoints
Note: To access the API with your GitHub App, you must provide a custom media type in the Accept Header for your requests.
application/vnd.github.machine-man-preview+json
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.
The following endpoints are available for use by GitHub Apps. Your app can make the following requests using REST v3 endpoints. For more information, see "GitHub Apps."
You must use an installation access token to access these endpoints.
Actions Secrets
- Get a repository public key
- List repository secrets
- Get a repository secret
- Create or update a repository secret
- Delete a repository secret
- Get an organization public key
- List organization secrets
- Get an organization secret
- Create or update an organization secret
- List selected repositories for an organization secret
- Set selected repositories for an organization secret
- Add selected repository to an organization secret
- Remove selected repository from an organization secret
- Delete an organization secret
Artifacts
- List artifacts for a repository
- List workflow run artifacts
- Get an artifact
- Delete an artifact
- Download an artifact
Check Runs
- Create a check run
- Get a check run
- Update a check run
- List check run annotations
- List check runs in a check suite
- List check runs for a Git reference
Check Suites
- Create a check suite
- Get a check suite
- Rerequest a check suite
- Update repository preferences for check suites
- List check suites for a Git reference
Code Scanning
Codes Of Conduct
Content References
Deployment Statuses
Deployments
Events
- List public events
- List public events for a network of repositories
- List public organization events
- List events for the authenticated user
- List public events for a user
- List events received by the authenticated user
- List public events received by a user
Feeds
Git Blobs
Git Commits
Git Refs
Git Tags
Git Trees
Gitignore Templates
Installations
Interaction Limits
- Get interaction restrictions for an organization
- Set interaction restrictions for an organization
- Remove interaction restrictions for an organization
- Get interaction restrictions for a repository
- Set interaction restrictions for a repository
- Remove interaction restrictions for a repository
Issue Assignees
Issue Comments
- List issue comments
- Create an issue comment
- List issue comments for a repository
- Get an issue comment
- Update an issue comment
- Delete an issue comment
Issue Events
Issue Timeline
Issues
- List assignees
- Check if a user can be assigned
- List repository issues
- Create an issue
- Get an issue
- Update an issue
- Lock an issue
- Unlock an issue
Jobs
Labels
- List labels for an issue
- Add labels to an issue
- Set labels for an issue
- Remove all labels from an issue
- Remove a label from an issue
- List labels for a repository
- Create a label
- Get a label
- Update a label
- Delete a label
- Get labels for every issue in a milestone
Licenses
Markdown
Meta
Milestones
Organization Hooks
- List organization webhooks
- Create an organization webhook
- Get an organization webhook
- Update an organization webhook
- Delete an organization webhook
- Ping an organization webhook
Organization Invitations
- List pending organization invitations
- Create an organization invitation
- List organization invitation teams
Organization Members
- List organization members
- Check organization membership for a user
- Remove an organization member
- Get organization membership for a user
- Set organization membership for a user
- Remove organization membership for a user
- List public organization members
- Check public organization membership for a user
Organization Outside Collaborators
- List outside collaborators for an organization
- Convert an organization member to outside collaborator
- Remove outside collaborator from an organization
Organization Team Projects
- List team projects
- Check team permissions for a project
- Add or update team project permissions
- Remove a project from a team
Organization Team Repositories
- List team repositories
- Check team permissions for a repository
- Add or update team repository permissions
- Remove a repository from a team
Organization Team Sync
- List idp groups for a team
- Create or update idp group connections
- List IdP groups for an organization
Organization Teams
- List teams
- Create a team
- Get team membership for a user
- Add or update team membership for a user
- Remove team membership for a user
- List child teams
Organizations
Organizations Credential Authorizations
- List SAML SSO authorizations for an organization
- Remove a SAML SSO authorization for an organization
SCIM
- List SCIM provisioned identities
- Provision and invite a SCIM user
- Get SCIM provisioning information for a user
- Set SCIM information for a provisioned user
- Update an attribute for a SCIM user
- Delete a SCIM user from an organization
Project Collaborators
- List project collaborators
- Add project collaborator
- Remove project collaborator
- Get project permission for a user
Projects
- List organization projects
- Create an organization project
- Get a project
- Update a project
- Delete a project
- Create a project card
- List project columns
- Create a project column
- Get a project column
- Update a project column
- Delete a project column
- List project cards
- Move a project column
- Get a project card
- Update a project card
- Delete a project card
- Move a project card
- List repository projects
- Create a repository project
Pull Comments
- List review comments on a pull request
- Create a review comment for a pull request
- List review comments in a repository
- Get a review comment for a pull request
- Update a review comment for a pull request
- Delete a review comment for a pull request
Pull Request Review Events
Pull Request Review Requests
- List requested reviewers for a pull request
- Request reviewers for a pull request
- Remove requested reviewers from a pull request
Pull Request Reviews
- List reviews for a pull request
- Create a review for a pull request
- Get a review for a pull request
- Update a review for a pull request
- Delete a pending review for a pull request
- List comments for a pull request review
Pulls
- List pull requests
- Create a pull request
- Get a pull request
- Update a pull request
- List commits on a pull request
- List pull requests files
- Check if a pull request has been merged
- Merge a pull request (Merge Button)
Reactions
- Delete a reaction
- List reactions for a commit comment
- Create reaction for a commit comment
- List reactions for an issue
- Create reaction for an issue
- List reactions for an issue comment
- Create reaction for an issue comment
- List reactions for a pull request review comment
- Create reaction for a pull request review comment
- List reactions for a team discussion comment
- Create reaction for a team discussion comment
- List reactions for a team discussion
- Create reaction for a team discussion
- Delete a commit comment reaction
- Delete an issue reaction
- Delete a reaction to a commit comment
- Delete a pull request comment reaction
- Delete team discussion reaction
- Delete team discussion comment reaction
Repositories
- List organization repositories
- Create a repository for the authenticated user
- Get a repository
- Update a repository
- Delete a repository
- Compare two commits
- List repository contributors
- List forks
- Create a fork
- List repository languages
- List repository tags
- List repository teams
- Transfer a repository
- List public repositories
- List repositories for a user
Repository Activity
- List stargazers
- List watchers
- List repositories starred by a user
- List repositories watched by a user
Repository Automated Security Fixes
Repository Branches
- List branches
- Get a branch
- Get branch protection
- Update branch protection
- Delete branch protection
- Get admin branch protection
- Set admin branch protection
- Delete admin branch protection
- Get pull request review protection
- Update pull request review protection
- Delete pull request review protection
- Get commit signature protection
- Create commit signature protection
- Delete commit signature protection
- Get status checks protection
- Update status check potection
- Remove status check protection
- Get all status check contexts
- Add status check contexts
- Set status check contexts
- Remove status check contexts
- Get access restrictions
- Delete access restrictions
- List teams with access to the protected branch
- Add team access restrictions
- Set team access restrictions
- Remove team access restriction
- List users with access to the protected branch
- Add user access restrictions
- Set user access restrictions
- Remove user access restrictions
- Merge a branch
Repository Collaborators
- List repository collaborators
- Check if a user is a repository collaborator
- Add a repository collaborator
- Remove a repository collaborator
- Get repository permissions for a user
Repository Commit Comments
- List commit comments for a repository
- Get a commit comment
- Update a commit comment
- Delete a commit comment
- List commit comments
- Create a commit comment
Repository Commits
Repository Community
Repository Content References
Repository Contents
- Download a repository archive
- Get repository content
- Create or update file contents
- Delete a file
- Get a repository README
- Get the license for a repository
Repository Hooks
- List repository webhooks
- Create a repository webhook
- Get a repository webhook
- Update a repository webhook
- Delete a repository webhook
- Ping a repository webhook
- Test the push repository webhook
Repository Invitations
Repository Keys
Repository Pages
- Get a GitHub Pages site
- Create a GitHub Pages site
- Update information about a GitHub Pages site
- Delete a GitHub Pages site
- List GitHub Pages builds
- Get GitHub Pages build
- Get latest pages build
Repository Releases
- List releases
- Create a release
- Get a release
- Update a release
- Delete a release
- List release assets
- Get a release asset
- Update a release asset
- Delete a release asset
- Get the latest release
- Get a release by tag name
Repository Stats
- Get the weekly commit activity
- Get the last year of commit activity
- Get all contributor commit activity
- Get the weekly commit count
- Get the hourly commit count for each day
Repository Vulnerability Alerts
Root
Runners
- List runner applications for a repository
- List self-hosted runners for a repository
- Get a self-hosted runner for a repository
- Delete a self-hosted runner from a repository
- Create a registration token for a repository
- Create a remove token for a repository
- List runner applications for an organization
- List self-hosted runners for an organization
- Get a self-hosted runner for an organization
- Delete a self-hosted runner from an organization
- Create a registration token for an organization
- Create a remove token for an organization
Search
- Search code
- Search commits
- Search issues and pull requests
- Search labels
- Search repositories
- Search topics
- Search users
Statuses
- Get the combined status for a specific reference
- List commit statuses for a reference
- Create a commit status
Team Discussions
- List discussions
- Create a discussion
- Get a discussion
- Update a discussion
- Delete a discussion
- List discussion comments
- Create a discussion comment
- Get a discussion comment
- Update a discussion comment
- Delete a discussion comment
Topics
Traffic
User Blocking
- List users blocked by an organization
- Check if a user is blocked by an organization
- Block a user from an organization
- Unblock a user from an organization
User Followers
User Gpg Keys
User Public Keys
Users
Workflow Runs
- List workflow runs for a repository
- Get a workflow run
- Cancel a workflow run
- Download workflow run logs
- Delete workflow run logs
- Re run a workflow
- List workflow runs