Using Snyk AppRisk with Snyk Broker
Snyk AppRisk has many third-party integrations with security and development tools. If these tools are hosted within your private network and are not directly accessible from the internet, you must use Snyk Broker to establish a connection.
Integrate AppRisk with Broker
The specific information you need to integrate Snyk AppRisk with Snyk Broker depends on the type of Snyk Broker deployment you are using: Classic Broker or Universal Broker.
Prerequisite for using Snyk AppRisk with Classic Broker
Required: Your Snyk Broker token.
How to obtain it:
Contact the Snyk Support team.
Alternatively, generate it yourself by following the instructions to Obtain your Broker token from the Web UI.
Prerequisite for using Snyk AppRisk with Universal Broker
Required: The identifier for your connection specific to your Universal Broker setup.
How to obtain it: You can find this identifier by referring to the Validate your deployment (optional) section within the Basic steps to install and configure Universal Broker documentation.
Final step in integration for both Broker types
After you have your Snyk Broker token
for Classic Broker or your connection identifier
for Universal Broker:
Copy the token or identifier value.
Navigate to the Snyk AppRisk integration settings within the Group-level Integration Hub.
Paste the value into the Broker token field to complete the integration.
Integrate a third-party tool with Snyk Broker
To integrate a third-party tool with Universal Broker, refer to Setting up and integrating your Universal Broker connections.
Configure third-party integrations with the integration password
After implementing all the general steps applicable to third-party integrations, you can configure the integration with unique credentials, as shown in this example. Run the following commands using your password:
Configure third-party integrations with the API token
After you implement all the general steps applicable to third-party integrations, you can configure the integration with unique credentials, such as INTEGRATION_HOST_URL
and INTEGRATION_API_TOKEN
as the values for the credentials reference. Run the following commands with your host URL and Broker token:
Configuration complete
After the Snyk Broker connection with a third-party integration is established, the following message is displayed in the logs: successfully established a websocket connection to the broker server
.
Last updated
Was this helpful?