Skip to main content
Before you can create a new connection we need a few prerequisites: an API Key and an Organization. For more information on these two items please review our quick start guide here. The last step of the quick start describes how to create a new connection, the POST body consists of:
  1. vendor - The Enum of the vendor product you want to connect to.
  2. credentials - The specific credential body for the vendor you are connecting to, this is not required for Oauth based connections.
  3. options - (Optional) Any additional options you want to pass to the connection, each vendor has different options available.
Since creating a connection requires you to have the correct combination of vendor, credentials, and options in the correct combination we have provided examples of each below.

VMS Connections

Admin consent — the customer authorizes Leen’s Microsoft Defender app. The response carries an oauth2_authorize_url to send them to.
Or the customer’s own app registration. All three values are required together, and the response carries no oauth2_authorize_url — the connection is active immediately.
More info on both flows can be found here

EDR Connections

Admin consent — the customer authorizes Leen’s Microsoft Defender app. The response carries an oauth2_authorize_url to send them to.
Or the customer’s own app registration. All three values are required together, and the response carries no oauth2_authorize_url — the connection is active immediately.
More info on both flows can be found here

AppSec Connections

Both routes below take base_url, which selects the Snyk region. It must be one of https://app.snyk.io (US-01, the default), https://app.us.snyk.io (US-02) or https://app.eu.snyk.io (EU-01). Use the app hostname, not the API one. On the OAuth route it also decides which region the returned oauth2_authorize_url points at, so send it whenever the customer is not on US-01.OAuth — the customer authorizes Leen’s Snyk app. The response carries an oauth2_authorize_url to send them to.
Or a Snyk API token, from a service account with the Org Admin role. The response carries no oauth2_authorize_url — the connection is active immediately.
More info on both flows can be found here

IDP Connections

More info on our OAuth flow can be found here

TPRM Connections