This version of GitHub Enterprise will be discontinued on 2022-02-16. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Suspending a GitHub App installation

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

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.

If an installation has been suspended by the GitHub App owner, installation owners cannot unsuspend their installations of the GitHub App. However, installation owners can change other settings, such as repository selection, while the app is suspended.

  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?

Privacy policy

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.