Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3
Info

NOTES:

  • API capabilities require a Teams or Enterprise license. Contact your CSM for more details.

  • For customers who have enabled vulnerability-based alerting, there are several changes to API version 1.3 -  refer here for details.

  • This page covers APIs for version 1.3. All version 1.3 APIs must include:

...

Parameter

Description

requestType

For details, see Supported API Requests.

orgToken

Your organization API key.

productToken

A unique identifier for your product.

projectToken

A unique identifier for your project.

...

The following characters are NOT supported as API input: <, >, % and &

Supported API Requests

Policies APIs

Alerts APIs

Groups and Users APIs

Reports APIs

  • Get Inventory Report

  • Get Source File Inventory Report

  • Get Due Diligence Report

  • Get Attribution Report

  • Get Product Comparison Report

  • Get Project Comparison Report

  • Get Custom Attribute Values Report

  • Get Library Location Report

  • Get License Compatibility Report

  • Get Effective Licenses Report

  • Get In-House Report

  • Get Risk Report

  • Get Vulnerabilities Report

  • Get Container Vulnerabilities Report

  • Get Effective Usage Analysis Report

  • Get Alerts Report

  • Get Ignored Alerts Report

  • Get Alert Resolution Duration Report

  • Get Change Log History Report

  • Get Request History Report

  • Get Plugin Request History Report

  • Get Members Report

  • Get Security Alerts by Vulnerability Report

  • Get Security Alerts by Library Report

  • Get License and Compliance Alerts Report

Licenses and Library APIs

  • Get Licenses

  • Get Licenses Histogram

  • Get Licenses Text Zip File

  • Get Copyrights Text File

  • Get Notices Text File

  • Set Library Notices

  • Get Library Locations

  • Change Original Library

Global Org/Organization/Product/Project APIs

  • Create Global Organization

  • Assign Global Organization to an Organization

  • Remove Global Organization from an Organization

  • Get Organizations

  • Get Organization Details

  • Change Organization Policy Owner

  • Get Products

  • Get Organization Product Vitals

  • Get Projects

  • Get Organization Project Vitals

  • Get Product Project Vitals

  • Get Project Vitals

  • Get In-House Libraries

  • Unmark In-House Libraries

...