Apps

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Actions

Enter a search term to find it in the GitHub Docs.

Apps - GitHub AE Docs

Use the REST API to retrieve information about GitHub Apps and GitHub App installations.

Quickstart

Comparing GitHub's APIs

Resources in the REST API

Rate limits

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

Octocat App

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

The number of installations associated with the GitHub app

The set of permissions for the GitHub app

GitHub app

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the <code>installations_count</code> in the response. For more details about your app's installations, see the "<a href="https://docs.github.com/github-ae@latest/rest/apps/apps#list-installations-for-the-authenticated-app">List installations for the authenticated app</a>" endpoint.
You must use a <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.

Get the authenticated app

Use this endpoint to complete the handshake necessary when implementing the <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/">GitHub App Manifest flow</a>. When you create a GitHub App with the manifest flow, you receive a temporary <code>code</code> used to retrieve the GitHub App's <code>id</code>, <code>pem</code> (private key), and <code>webhook_secret</code>.

code

Validation failed, or the endpoint has been spammed.

Create a GitHub App from a manifest

List of integration installation requests

Request to install an integration on a target

Integration Installation Request

Lists all the pending installation requests for the authenticated GitHub App.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List installation requests for the authenticated app

The permissions the installation has are included under the <code>permissions</code> key.

Installation

You must use a <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.
The permissions the installation has are included under the <code>permissions</code> key.

Only show results that were last updated after the given time. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.

since

outdated

List installations for the authenticated app

The permissions granted to the user access token.

App Permissions

Describe whether all repositories have been selected or there's a selection involved

The ID of the user or organization this token is being scoped to.

Enables an authenticated GitHub App to find an installation's information using the installation id.
You must use a <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.

The unique identifier of the installation.

installation_id

Get an installation for the authenticated app

Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "<a href="https://docs.github.com/github-ae@latest/rest/apps/apps#suspend-an-app-installation">Suspend an app installation</a>" endpoint.
You must use a <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.

Delete an installation for the authenticated app

List of repository names that the token should have access to

repositories

List of repository IDs that the token should have access to

repository_ids

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.

actions

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.

administration

The level of permission to grant the access token for checks on code.

checks

The level of permission to grant the access token to create, edit, delete, and list Codespaces.

codespaces

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.

dependabot_secrets

The level of permission to grant the access token for deployments and deployment statuses.

deployments

The level of permission to grant the access token for managing repository environments.

environments

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.

issues

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.

metadata

The level of permission to grant the access token for packages published to GitHub Packages.

packages

The permissions granted to the user access token.

permissions

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.
You must use a <a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.

Create an installation access token for an app