Still using Xray 1.x ?
JFrog Xray 1.x User Guide
Need help with other JFrog products ?
Have a question? Want to report an issue? Contact JFrog support
The Add Integration dialog shows all available integrations you can connect to, and provides the option to add a custom integration. Select the provider you wish to connect to from the list of icons displayed, or click the plus sign to add a custom integration.
To connect to a provider, set the Enabled checkbox and enter the following parameters:
Aqua Security offers a comprehensive security solution for containerized environments. If you have an account with Aqua, you may enable this feed, enter your Aqua API key, the URL of your on-prem Aqua installation and the test URL.
WhiteSource offers a security and license management solution for your open source components. If you have an account with WhiteSource, you may enable this feed and enter your WhiteSource API key, URL and Test URL.
Black Duck offers an enterprise-grade solution to automate the process of securing, managing, and ensuring license compliance for open source software in applications and containers. If you are a Black Duck customer, you may enable this feed by purchasing the standard Hub edition with the security module, enter the provided Black Duck API key, the URL of your Black Duck installation and the test URL to start using Black Duck data within Xray.
In addition to the integrations included out-of-the-box, Xray also allows you to create custom integrations. This gives you the opportunity to add analyses from different providers with whom you may have an account, or even to create your own provider and display information such as performance issues, known defects or any other information offered by your provider.
To enable this, you'll need to build the following two REST endpoints and configure them in the Xray integrations page.
In order to enable your custom integration, you need to build and run two REST endpoints.
Request an indication to whether a provided api key is valid. This API should be exposed by the feed provider.
This API will allow Xray to request for information about one or more components, each identified by a unique component id, from the feed provider. The API will be implemented by the feed provider.
The request payload will contain unique identifiers of the components Xray would like to get information about.
In addition Xray will provide a context to the request, this can be a project id or another identifier. If the 3rd party service allows its users to define policies per project, this will allow to answer the request in the context of those policies. For example, if the 3rd party service allows creating policies for OSS license compliance per project, Xray may get a response with a license vulnerability if the queried component is violating the policy.
To configure your endpoints, go to the integrations page and click on the custom integration.
To add and connect to a custom provider, set the Enabled checkbox and enter the following parameters: