Set up a GitHub connection using the API
This page provides an example of using the Snyk API to set up a GitHub connection with the Universal Broker. Repeat connecting your Organization for as many integrations as needed.
Using the snyk-broker-config
command is recommended for an easier experience. The API allows for automation and more control, and also requires a clear understanding of Broker deployments, credentials, and connections.
In any of the calls that follow, replace api.snyk.io
with your regional equivalent if necessary, for example, api.eu.snyk.io
.
Install the Broker App for your Organization
Install the Universal Broker App at the Organization level. Group-level installation is not supported. Use the endpoint Install a Snyk App to this Organization. The following is the App ID to use when you call the API:
Snyk Broker App ID: cb43d761-bd17-4b44-9b6c-e5b8ad077d33
Create your deployment
Use the following call to create your deployment.