👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Learn more on the GitHub blog.

Suspending a GitHub App installation

You can temporarily block a GitHub App's access to your account's resources by suspending the app.

In this article

Were you able to find what you were looking for?

Note: Suspending a GitHub App installation is currently in beta and subject to change. Before you can suspend a GitHub App, the app owner must enable suspending installations for the app by opting-in to the beta.

Opting-in to the suspending installations beta

Before a GitHub App can be suspended, the GitHub App owner must opt-in to the suspending installations beta.

  1. In the upper-right corner of any page, click your profile photo, then click Settings.
    Settings icon in the user bar
  2. In the left sidebar, click Developer settings.
    Developer settings section
  3. In the left sidebar, click GitHub Apps.
    GitHub Apps section
  4. Select the GitHub App you want to suspend.
    App selection
  5. In the left sidebar, click Beta Features.
    Beta features side bar option
  6. Next to "Suspending installations", click Opt-in. You can opt-out at any time.
    Opt-in or opt-out to suspending installations

Suspending a GitHub App

To suspend a GitHub App, you must be an account owner or have admin permissions in the repository or organization where the app you want to suspend is installed.

You can also suspend and unsuspend GitHub App installations using the REST API. For more information, see the GitHub Apps REST API.

  1. In the upper-right corner of any page, click your profile photo, then click Settings.
    Settings icon in the user bar
  2. In the left sidebar, click Developer settings.
    Developer settings section
  3. In the left sidebar, click GitHub Apps.
    GitHub Apps section
  4. Select the GitHub App you want to suspend.
    App selection
  5. In the left sidebar, click Advanced.
    Advanced tab
  6. Next to the suspension settings for the installation, click Suspend or Unsuspend.
    Suspend a GitHub App

Were you able to find what you were looking for?

Ask a human

Can't find what you're looking for?

Contact us