GitHub Cloud App
Release status
The GitHub Cloud App is in Early Access. This feature is not supported for Snyk Broker or self-hosted instances of GitHub.
As Snyk does not have static IP addresses, this integration will not work with IP allowlisting in GitHub.
When you want to add new integrations to your Snyk account you need to first decide the level type at which you want to install the integration.
Group level - Add integrations to your Snyk application that will be available for your Snyk AppRisk Essentials or Snyk AppRisk Pro. If you want to set up integrations for Snyk AppRisk, use the Integrations menu at the Group level.
Organization level - Add integrations for your Snyk application that will be available for all Snyk products, except Snyk AppRisk.
Organization level - Snyk integrations
Prerequisites for GitHub Cloud App
Snyk Organization Admin user role.
GitHub Organization Admin user role.
A public or private GitHub repository.
The required app permissions. For more information, see GitHub Cloud App permission requirements.
Users can install the app on GitHub Organizations they are Repository Admins on through the GitHub UI.
GitHub Cloud App benefits
The GitHub Cloud App improves on many features as compared to the current GitHub integration, including role-based, granular access control, increased API rate limits, and creation of an entry point for expanded and enhanced developer experiences.
RBAC (Role-Based Access Control) Compliance: With the GitHub Cloud App, the access control mechanism is decoupled from individual user accounts. Instead, it is associated with the app entity itself. This separation allows for better management and enforcement of RBAC policies, as access control is handled at the application level rather than being tied to individual user accounts.
Granular access control: The GitHub Cloud App allows for fine-grained control over access permissions at the repository level.
Increased API rate limit: The GitHub Cloud App provides higher rate limits, allowing Snyk to make a larger number of API requests. This increased limit will assist in handling large-scale use cases, such as monorepos with a large number of Projects, GitHub organizations with a large number of repositories, and more.
Enabler for an enhanced developer experience:
Pull request checks: The Checks tab experience in GitHub is exclusively accessible through the GitHub Cloud App, enabling an SCM native experience as part of potential future PR check workflow improvements.
Fix and upgrade pull requests: Pull requests initiated by Snyk are performed directly by the GitHub App rather than a service account.
How to set up the GitHub Cloud App
When setting up the GitHub Cloud App, you can only implement one of the following scenarios:
One GitHub organization connected to one Snyk Organization
One GitHub organization connected to multiple Snyk Organizations
Log in to your Snyk account and navigate to the Integrations section in the Snyk Organization where you would like to set up the GitHub Cloud App.
Select the GitHub Cloud App tile.
In the confirmation modal, select Configure GitHub Cloud App.
You are then asked to authorize the app to act on your user’s behalf. The app uses this information to check which GitHub organizations you are authorized to install the app in.
When the install screen in GitHub opens, you can select the GitHub organization where you wish to install the app.
If the GitHub Cloud App is already installed in a GitHub organization, you can select that same GitHub organization during the integration process for a different Snyk Organization.
Specify whether you wish to install the app in all of the repositories belonging to the selected GitHub organization, or you want to install the app in a select number of repositories belonging to a GitHub organization; then click Install & Authorize.
The GitHub Cloud App will lose access to Snyk if it is uninstalled from the GitHub organization or if the repositories to which the app instance has access are edited.
How to migrate to the GitHub Cloud App
If you are an Enterprise plan customer, you can migrate Snyk Targets to the GitHub Cloud App using the snyk-migrate-to-github-app tool in the tool repository.
Feedback on the GitHub Cloud App
Because this feature is in Early Access, the functionality will likely evolve based on your feedback. If you would like to provide any feedback, contact your Account Manager or Snyk support.
Group level - Snyk AppRisk integrations
Navigate to the GitHub setup guide for Snyk AppRisk for all details on how to set up the GitHub integration for Snyk AppRisk.
Last updated
