Suspending a GitHub App installation

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

Did this doc help you?

Help us make these docs great!

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

Make a contribution

Or, learn how to contribute.

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. To opt-in to the suspending installations beta feature, see "Activating beta features for apps."

Suspending a GitHub App

The integrator who owns and maintains a GitHub app, also called a GitHub App owner, can suspend or unsuspend a GitHub App installation using REST API endpoints with a JWT. For more information, see the GitHub Apps REST API.

People who have installed a GitHub App, also called installation owners, can only suspend or unsuspend a GitHub App through their app's installation settings. Installation owners cannot use the API to suspend or unsuspend their app installation. Before people can suspend a GitHub app installation, the GitHub App owner must opt-in to the beta release. For more information, see "Suspending a GitHub App installation."

  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

Did this doc help you?

Help us make these docs great!

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

Make a contribution

Or, learn how to contribute.