Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

Overview

The WhiteSource Mend HTTP API is available for WhiteSource Mend customers who are licensed to use it. The APIs can be accessed by the organization's administrator(s). 

...

This document describes the WhiteSource Mend HTTP API v1.3. The API URL can be obtained by copying the WhiteSource Mend 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.whitesourcesoftwareMendsoftware.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 Mend API version is currently still supported, and is documented in the HTTP API v1.2 page.

...

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 WhiteSourceMend, 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:

...

All requests require a token available via the API Integration page in your WhiteSource Mend account, according to the request's context (organization / product / project).

...

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.

Character Sets

WhiteSource Mend HTTP API v1.x supports Accept-Charset header.

...

Reports APIs

...