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 your GitHub Enterprise site administrator.
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.
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
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
Issue Assignees
Issue Comments
- List comments on an issue
- Create a comment
- List comments in a repository
- Get a single comment
- Edit a comment
- Delete a comment
Issue Events
Issue Timeline
Issues
- List assignees
- Check assignee
- List repository issues
- Create an issue
- Get an issue
- Update an issue
- Lock an issue
- Unlock an issue
Labels
- List labels on an issue
- Add labels to an issue
- Replace all labels for an issue
- Remove all labels from an issue
- Remove a label from an issue
- List all labels for this repository
- Create a label
- Get a single label
- Update a label
- Delete a label
- Get labels for every issue in a milestone
Licenses
Markdown
Meta
Milestones
- List milestones for a repository
- Create a milestone
- Get a single milestone
- Update a milestone
- Delete a milestone
Organization Hooks
Organization Members
- Members list
- Check membership
- Remove a member
- Get organization membership
- Add or update organization membership
- Remove organization membership
- Public members list
- Check public membership
Organization Outside Collaborators
Organization Pre Receive Hooks
- List pre-receive hooks
- Get
- Update pre-receive hook enforcement
- Remove enforcement overrides for a pre-receive hook
Organization Team Projects
Organization Team Repositories
- List team repos
- Check if a team manages a repository
- Add or update team repository
- Remove team repository
Organization Teams
- List teams
- Create team
- Get team membership
- Add or update team membership
- Remove team membership
- List child teams
Organizations
Project Collaborators
- List collaborators
- Add user as a collaborator
- Remove user as a collaborator
- Review a user's permission level
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 comments on a pull request
- Create a comment
- List comments in a repository
- Get a single comment
- Edit a comment
- Delete a comment
Pull Request Review Events
Pull Request Review Requests
Pull Request Reviews
- List reviews on a pull request
- Create a pull request review
- Get a single review
- Update a pull request review
- Delete a pending review
- Get comments for a single review
Pulls
- List pull requests
- Create a pull request
- Get a single pull request
- Update a pull request
- List commits on a pull request
- List pull requests files
- Get 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
Repositories
- List organization repositories
- Create a repository for the authenticated user
- Get a repository
- Update a repository
- Delete a repository
- Compare two commits
- List contributors
- List forks
- Create a fork
- List languages
- List tags
- List 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 Branches
- List branches
- Get branch
- Get branch protection
- Update branch protection
- Remove branch protection
- Get admin enforcement of protected branch
- Add admin enforcement of protected branch
- Remove admin enforcement of protected branch
- Get pull request review enforcement of protected branch
- Update pull request review enforcement of protected branch
- Remove pull request review enforcement of protected branch
- Get required signatures of protected branch
- Add required signatures of protected branch
- Remove required signatures of protected branch
- Get required status checks of protected branch
- Update required status checks of protected branch
- Remove required status checks of protected branch
- List required status checks contexts of protected branch
- Add required status checks contexts of protected branch
- Replace required status checks contexts of protected branch
- Remove required status checks contexts of protected branch
- Get restrictions of protected branch
- Remove restrictions of protected branch
- List teams with access to protected branch
- Add team restrictions of protected branch
- Replace team restrictions of protected branch
- Remove team restrictions of protected branch
- List users with access to protected branch
- Add user restrictions of protected branch
- Replace user restrictions of protected branch
- Remove user restrictions of protected branch
- Perform a merge
Repository Collaborators
- List collaborators
- Check if a user is a collaborator
- Add user as a collaborator
- Remove user as a collaborator
- Review a user's permission level
Repository Commit Comments
- List commit comments for a repository
- Get a single commit comment
- Update a commit comment
- Delete a commit comment
- List comments for a single commit
- Create a commit comment
Repository Commits
Repository Community
Repository Content References
Repository Contents
- Get archive link
- Get contents
- Create or update a file
- Delete a file
- Get the contents of a repository's license
- Get the readme
Repository Hooks
Repository Invitations
Repository Keys
Repository Pages
- Get information about a pages site
- Enable a pages site
- Update information about a pages site
- Disable a pages site
- List pages builds
- Get a specific pages build
- Get latest pages build
Repository Pre Receive Hooks
- List pre-receive hooks
- Get
- Update pre-receive hook enforcement
- Remove enforcement overrides for a pre-receive hook
Repository Releases
- List releases for a repository
- Create a release
- Get a single release
- Edit a release
- Delete a release
- List assets for a release
- Get a single release asset
- Edit a release asset
- Delete a release asset
- Get the latest release
- Get a release by tag name
Repository Stats
- Get the number of additions and deletions per week
- Get the last year of commit activity data
- Get contributors list with additions, deletions, and commit counts
- Get the weekly commit count for the repository owner and everyone else
- Get the number of commits per hour in each day
Root
Search
- Search code
- Search commits
- Search issues and pull requests
- Search labels
- Search repositories
- Search topics
- Search users
Statuses
Team Discussions
- List discussions
- Create a discussion
- Get a single discussion
- Edit a discussion
- Delete a discussion
- List comments
- Create a comment
- Get a single comment
- Edit a comment
- Delete a comment