Components of Snyk Broker
PreviousRestart your Broker with the required environment variable and connectNextConnections with Snyk Broker
Last updated
Last updated
More information
Snyk privacy policy© 2024 Snyk Limited | All product and company names and logos are trademarks of their respective owners.
The Broker client and server act together as a tunnel to your code, sending requests by proxy from snyk.io to a Git repository, fetching the files needed for scanning, for example, manifest files, from monitored repositories, and fetching results using webhooks posted by the Git service. You will install the Broker client. The Broker server is provided by Snyk and does not require installation.
The Broker client runs within your internal network, keeping sensitive data such as Git tokens within the network perimeter. The tunnel allows for scanning using only requests on an approved data list. This narrows the access permissions to the absolute minimum required for Snyk to monitor a repository. For more information, see Approved data list for Snyk Broker.
For information about components required for using Snyk Code Agent, Snyk Container Registry Agent, and Snyk Broker for Infrastructure as Code, see Define your Broker deployment components.
The diagram that follows illustrates how the basic components operate.
All data, both in transit and at rest, is encrypted.
Communication between the Client and the Server is over a secure WebSocket connection.
There is no need to open incoming ports since the communication is initiated outbound.
After the connection is initiated, the WebSocket connection is bi-directional.
For details about the connections between Snyk and the Broker Client and allowed requests, see Connections with Snyk Broker.
