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:
A valid ‘userKey’. See User Level Access Control in Integrations and APIs. The "Enforce user level access" settings is not required for API calls.
Overview
The WhiteSource HTTP API is available for WhiteSource customers who are licensed to use it. The APIs can be accessed by the organization's administrator(s).
The API is simply an HTTP endpoint implementing a JSON speaking web service and handling POST requests. Like the service itself, communication is secured with SSL.
This document describes the WhiteSource HTTP API v1.3. The API URL can be obtained by copying the WhiteSource Server URL, which can be retrieved from your Profile page on the Server URLs panel. Then, add the path /api/v1.3 to it. For example: https://saas.whitesourcesoftware.com/api/v1.3.
Regarding version numbers, if there are 3 or more version parts, (for example, x.y.z or x.y.z.w) both x and y are considered a major version (x.y).
If there are 2 major parts (x.y), then x is considered a major version.
NOTE: The previous WhiteSource API version is currently still supported, and is documented in the HTTP API v1.2 page.
Note the following about API calls:
When performing API calls, the time recorded for the action is in GMT time zone, therefore, this is the time displayed in the relevant reports.
Date format in all responses is "yyyy-MM-dd".
The API results are not sorted in any order.
API Execution Scope
Generally, each level of the administrator (Organization, Product) can get/set the API attributes in the API calls that refer to their scope and/or under their scope. For example, Product administrators can execute API calls related to their Projects/Products that are defined in WhiteSource, but they cannot execute Organization-related API calls which are outside their scope. However, there are two API calls that are exceptions to this rule:
getProjectVitals – Product administrators can use the Organization level call and get the product/project vitals related to their products/projects.
getRequestState – Although an Organization token is required in the call, a product administrator can also execute it.
API URL
The base URL for all API endpoints can be obtained from the Integrate tab (calls to HTTP cannot be redirected to HTTPS).
Only POST requests are accepted.
Request payload should have: Content-Type = application/json
API Format
All requests require a token available via the API Integration page in your WhiteSource account, according to the request's context (organization / product / project).
The requestType parameter is mandatory for all requests.
Parameter | Description |
|---|---|
requestType | For details, see Supported Requests. |
orgToken | Your organization API key. |
productToken | A unique identifier for your product. |
projectToken | A unique identifier for your project. |
Character Sets
WhiteSource HTTP API v1.x supports Accept-Charset header.
If the value of the header is a supported character set (see supported values below) the response would be in that character set.
Otherwise, if the value is not supported or if the header isn't sent, the default response character set will be UTF-8.
Supported character sets are:
utf-8
utf-16
iso-8859-1
iso-8859-2
iso-8859-4
iso-8859-5
iso-8859-7
iso-8859-9
us-ascii
Special Characters
The following characters are NOT supported as API input: <, >, % and &
Supported Requests
WhiteSource HTTP API v1.3 supports the following requests:
"addGlobalOrganizationPolicy", "addOrganizationPolicy", "addProductPolicy", "addProjectPolicy", "addUsersToGroups", "changeOriginLibrary", "clearOrganizationSourceFileMatchingResults", "clearProductSourceFileMatchingResults", "clearProjectSourceFileMatchingResults", "createGlobalOrg", "createGroup", "createProduct", "createProject", "createServiceUser", "createUser", "deleteProduct", "deleteProject", "fetchProjectPolicyIssues", "getAggregatedFix", "getAggregatedLibraryDetails", "getAlertsByProjectTag", "getAllGroups", "getAllOrganizations", "getAllProducts", "getAllProjects", "getAllUsers", "getChangeLogHistoryReport", "getChangesReport", "getClusterVulnerabilityReportRequest", "getCopyrightsTextFile", "getDirectDependencyVersion", "getGlobalLicenses", "getGlobalOrganizationPolicies", "getIntegrationActivationToken", "getIntegrationWorkflowRules", "getLibraryInfo", "getLibraryLicenses", "getLibrarySourceFiles", "getLibraryVulnerabilities", "getLicensesByPackageCoordinates", "getLicensesTextZip", "getNoticesTextFile", "getOrganizationAlerts", "getOrganizationAlertsByType", "getOrganizationAlertsReport", "getOrganizationAssignments", "getOrganizationAttributesReport", "getOrganizationBugsReport", "getOrganizationCapabilities", "getOrganizationContainerVulnerabilityReportRequest", "getOrganizationCustomAttributeValues", "getOrganizationDetails", "getOrganizationDueDiligenceReport", "getOrganizationEarlyWarningAlertReport", "getOrganizationEarlyWarningReport", "getOrganizationEffectiveLicensesReport", "getOrganizationEffectiveUsageAnalysis", "getOrganizationFileClustersReport", "getOrganizationIgnoredAlerts", "getOrganizationIgnoredAlertsReport", "getOrganizationInHouseLibraries", "getOrganizationInHouseReport", "getOrganizationInventoryReport", "getOrganizationLastModifiedProjects", "getOrganizationLibraryLocationReport", "getOrganizationLicenseAndComplianceAlertReport", "getOrganizationLicenseHistogram", "getOrganizationLicenses", "getOrganizationMembersReport", "getOrganizationPolicies", "getOrganizationProductTags", "getOrganizationProductVitals", "getOrganizationProjectTags", "getOrganizationProjectVitals", "getOrganizationRequestHistoryReport", "getOrganizationResolvedAlertsReport", "getOrganizationRiskReport", "getOrganizationSecurityAlertsByLibraryReport", "getOrganizationSecurityAlertsByVulnerabilityReport", "getOrganizationServiceUsers", "getOrganizationSourceFileInventoryReport", "getOrganizationVulnerabilityReport", "getPluginRequestHistoryReport", "getPolicyMatchesConfiguration", "getPolicyViolationHistoryReport", "getProductAlerts", "getProductAlertsByType", "getProductAlertsReport", "getProductAssignments", "getProductAttributesReport", "getProductAttributionReport", "getProductBugsReport", "getProductComparisonReport", "getProductCustomAttributeValues", "getProductDueDiligenceReport", "getProductEarlyWarningAlertReport", "getProductEarlyWarningReport", "getProductEffectiveLicensesReport", "getProductFileClustersReport", "getProductIgnoredAlerts", "getProductIgnoredAlertsReport", "getProductInHouseLibraries", "getProductInHouseReport", "getProductInventoryReport", "getProductLibraryLocationReport", "getProductLibraryLocations", "getProductLicenseAndComplianceAlertReport", "getProductLicenseCompatibilityReport", "getProductLicenseHistogram", "getProductLicenses", "getProductMembersReport", "getProductPolicies", "getProductProjectTags", "getProductProjectVitals", "getProductRequestHistoryReport", "getProductResolvedAlertsReport", "getProductRiskReport", "getProductSecurityAlertsByLibraryReport", "getProductSecurityAlertsByVulnerabilityReport", "getProductServiceUsers", "getProductSourceFileInventoryReport", "getProductTags", "getProductVulnerabilityReport", "getProjectAlerts", "getProjectAlertsByType", "getProjectAlertsReport", "getProjectAttributionReport", "getProjectBugsReport", "getProjectComparisonReport", "getProjectCopyrightsTextFile", "getProjectCustomAttributeValues", "getProjectDirectDependencies", "getProjectDueDiligenceReport", "getProjectEarlyWarningAlertReport", "getProjectEarlyWarningReport", "getProjectHierarchy", "getProjectIgnoredAlerts", "getProjectIgnoredAlertsReport", "getProjectInHouseLibraries", "getProjectInHouseReport", "getProjectInventory", "getProjectInventoryReport", "getProjectLibrariesInfo", "getProjectLibraryDependencies", "getProjectLibraryLocations", "getProjectLicenseAndComplianceAlertReport", "getProjectLicenseCompatibilityReport", "getProjectLicenseHistogram", "getProjectLicenses", "getProjectLicensesTextZip", "getProjectMembersReport", "getProjectPolicies", "getProjectRequestHistoryReport", "getProjectResolvedAlertsReport", "getProjectRiskReport", "getProjectSecurityAlertsByLibraryReport", "getProjectSecurityAlertsByVulnerabilityReport", "getProjectSourceFileInventoryReport", "getProjectState", "getProjectTags", "getProjectVitals", "getProjectVulnerabilityReport", "getRequestSchema", "getRequestState", "getServerCapabilities", "getSupportedRequests", "getVulnerabilitiesByFilename", "getVulnerabilitiesByHashes", "getVulnerabilitiesByPackageCoordinates", "getVulnerabilityProfiles", "hasBlockPolicy", "ignoreAlerts", "inviteUserToWebAdvisor", "inviteUsers", "librarySearch", "reassignPendingTasksAndConditions", "regenerateUserKey", "removeGlobalOrganizationPolicies", "removeOrganizationPolicies", "removeProductPolicies", "removeProductTag", "removeProjectPolicies", "removeProjectTag", "removeUserFromGroup", "removeUserFromOrganization", "renameProduct", "reorderGlobalOrganizationPolicyPriorities", "reorderOrganizationPolicyPriorities", "reorderProductPolicyPriorities", "reorderProjectPolicyPriorities", "saveProductTag", "saveProjectTag", "setAlertsStatus", "setGlobalOrganizationPolicyStates", "setLibraryNotice", "setOrganizationAssignments", "setOrganizationPolicyStates", "setProductAssignments", "setProductPolicyStates", "setProjectPolicyStates", "setProjectSetupNotificationConfig", "unmarkManualInHouseLibrary", "updateExternalIntegrationIssues", "updateGlobalOrganizationPolicy", "updateGlobalSamlIntegration", "updateMavenDependencyResolutionSettings", "updateOrganizationPolicy", "updateOrganizationSamlIntegration", "updateProductPolicy", "updateProjectPolicy"
Documentation of Supported API Requests
For documentation of API requests that relate to:
Policies, see Policies API
Alerts, see Alerts API
Groups and Users, see Groups and Users API
Reports, see Reports API
Licenses and Libraries, see Licenses and Library API
Global Orgs/Organizations/Products/Projects, see Global Org/Organization/Product/Project API
Products and Projects, see Product and Project-Level API