This version of GitHub Enterprise Server was discontinued on 2024-09-25. 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 Server. For help with the upgrade, contact GitHub Enterprise support.

Suspending a GitHub App installation

You can temporarily block your GitHub App from accessing resources owned by the accounts that installed the GitHub App.

Note

If you want to suspend a GitHub App that you use but do not own, see "Reviewing and modifying installed GitHub Apps" instead.

When a GitHub App is suspended for an installation, the GitHub App cannot access resources owned by that installation account. For example, you might want to suspend your GitHub App if you are worried that your app's credentials were leaked.

The owner of a GitHub App can suspend the GitHub App for a specific installation. If an organization has designated any app managers for an app owned by the organization, the app managers can also suspend the GitHub App for a specific installation. GitHub App owners and managers can only use the API to suspend their app, and they must suspend the app individually for each installation. For more information, see "REST API endpoints for GitHub Apps."

Users who installed a GitHub App on their personal account or organization can also suspend a GitHub App from accessing resources owned by their account. People who have installed a GitHub App can only use the GitHub web interface to suspend their app. For more information, see "Reviewing and modifying installed GitHub Apps."

A GitHub App must be unsuspended in the same way it was suspended. If an owner or manager of a GitHub App suspended the app, they can also unsuspend it, but the owner of an account where the app is installed cannot unsuspend it. Similarly, if the owner of an account where a GitHub App is installed suspended the app, they can also unsuspend it, but an owner or manager of the app cannot unsuspend it.