Software Supply Chain Intelligence REST API
Use the Software Supply Chain Intelligence (SSCI) REST API to retrieve a curated view of malware released across the open-source ecosystems that we monitor. Our automated risk analysis platform identifies packages in SSCI, and a team of security researchers then triages and reviews them. You can access the SSCI threat and reputation feeds through the unified Veracode API.
SSCI provides two endpoints:
- Threat feed: provides a paginated feed that includes summary about all known malicious packages detected by Veracode.
- Reputation database: accepts a list of package URLs (PURLs) and provides information about each package, including malware status, suspicious behavior, vulnerabilities, license data, and package metadata.
Set up permissions
Your Veracode API credentials must have access to SSCI. For additional help, contact Veracode Technical Support.
Authenticate with the API
This API uses OAuth 2.0 client credentials authentication. Use API credentials to authenticate in CI/CD environments without sharing account credentials. Request an access token from the following Veracode token endpoint:
https://api.veracode.com/api/authn/v2/oauth2/token
Provide the token in the authorization header of your requests. For more information, see API authentication.
SSCI API specification
The SSCI API specification is available from SwaggerHub.
Retrieve threat feed data
The threat feed returns information about malicious packages.
To retrieve threat feed data, send a GET request to the following endpoint:
https://api.veracode.com/ssci/v1/threats
For example, use HTTPie with an OAuth 2.0 plugin that supports the client credentials flow:
http --auth-type=oauth2-client-credentials-flow --auth="<veracode OAuth token with appropriate access>" --token-endpoint="https://api.veracode.com/api/authn/v2/oauth2/token" --token-request-type=basic GET https://api.veracode.com/ssci/v1/threats
Retrieve reputation database data
The reputation database provides information about each package you specify, including malware status, suspicious behavior, vulnerabilities, license data, and package metadata. You can identify each package by its PURL.
To retrieve reputation data, send a POST request with a JSON body that contains a purls array to the following endpoint:
https://api.veracode.com/ssci/v1/packages
For example, use HTTPie with an OAuth 2.0 plugin that supports the client credentials flow:
http --auth-type=oauth2-client-credentials-flow --auth="<veracode OAuth token with appropriate access>" --token-endpoint="https://api.veracode.com/api/authn/v2/oauth2/token" --token-request-type=basic POST https://api.veracode.com/ssci/v1/packages Content-Type:application/json purls:='["pkg:npm/[email protected]"]'
Include one or more PURLs in the purls array to retrieve data for multiple packages in a single request.