Page Comparison

requestType

API request type that returns all the alerts in an organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

requestType

API request type that returns all the alerts for a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

productToken

Unique identifier of the product.

string

Yes

requestType

API request type that returns all the alerts for a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

requestType

API request type that returns all alerts in the organization that have a specific project tag.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

tagKey

Label that describes the tag.

string

Yes

tagValue

Value assigned to the tag.

string

Yes

requestType

API request type that returns all the ignored alerts in an organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

requestType

API request type that returns all the ignored alerts for a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

productToken

Unique identifier of the product.

string

Yes

requestType

API request type that returns all the ignored alerts for a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

requestType

API request type that returns all the alerts in an organization according to the specified alert type.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

alertType

The type of alerts.

A detailed description of the permitted alert types is provided in Alert Types above.

string

Yes

Permitted alert type values:

NEW_MAJOR_VERSION

NEW_MAJOR_VERSION

NEW_MINOR_VERSION

SECURITY_VULNERABILITY

REJECTED_BY_POLICY_RESOURCE

MULTIPLE_LIBRARY_VERSIONS

HIGH_SEVERITY_BUG

MULTIPLE_LICENSES

REJECTED_DEFACTO_RESOURCE

fromDate

The first date in the time period during which the alerts were created or modified. When fromDate is not specified, the beginning of time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

toDate

The last date in the time period during which the alerts were created or modified. When toDate is not specified, the current date and time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

requestType

API request type that returns all the alerts generated for a product according to the specified alert type.

string

Yes

productToken

Unique identifier of the product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

alertType

The type of alert. For a detailed description, see Alert Types.

string

Yes

Permitted alert type values:

NEW_MAJOR_VERSION

NEW_MAJOR_VERSION

NEW_MINOR_VERSION

SECURITY_VULNERABILITY

REJECTED_BY_POLICY_RESOURCE

MULTIPLE_LIBRARY_VERSIONS

HIGH_SEVERITY_BUG

MULTIPLE_LICENSES

REJECTED_DEFACTO_RESOURCE

fromDate

The first date in the time period during which the alerts were created or modified. When fromDate is not specified, the beginning of time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

toDate

The last date in the time period during which the alerts were created or modified. When toDate is not specified, the current date and time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

requestType

API request type that returns all the alerts generated for a project according to the specified alert type.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

alertType

The type of alert. For a detailed description, see Alert Types.

string

Yes

Permitted alert type values:

NEW_MAJOR_VERSION

NEW_MAJOR_VERSION

NEW_MINOR_VERSION

SECURITY_VULNERABILITY

REJECTED_BY_POLICY_RESOURCE

MULTIPLE_LIBRARY_VERSIONS

HIGH_SEVERITY_BUG

MULTIPLE_LICENSES

REJECTED_DEFACTO_RESOURCE

fromDate

The first date in the time period during which the alerts were created or modified. When fromDate is not specified, the beginning of time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

toDate

The last date in the time period during which the alerts were created or modified. When toDate is not specified, the current date and time will be assumed.

string

No

Time is GMT. Format is:
YYYY-MM-DD or YYYY-MM-DD HH-MM-SS (if time is also specified).

requestType

API request type that ignores alerts in an organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

alertUuids

Unique IDs of the alerts to be ignored.

NOTE: The alert UUID is unique per CVE and therefore different for all the vulnerabilities related to the same library.

array

Yes

comments

Text comment describing why the alerts should be ignored.

string

Yes

requestType

API request type that ignores alerts in a product.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

productToken

Unique identifier of the product.

string

Yes

alertUuids

Unique IDs of the alerts to be ignored.

NOTE: The alert UUID is unique per CVE and therefore different for all the vulnerabilities related to the same library.

array

Yes

comments

Text comment describing why the alerts should be ignored.

string

Yes

requestType

API request type that ignores alerts in a project.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

projectToken

Unique identifier of the project.

string

Yes

alertUuids

Unique IDs of the alerts to be ignored.

NOTE: The alert UUID is unique per CVE and therefore different for all the vulnerabilities related to the same library.

array

Yes

comments

Text comment describing why the alerts should be ignored.

string

Yes

requestType

API request type that sets the alerts status in an organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend.

string

Yes

orgToken

API key which is a unique identifier of the organization.

string

Yes

alertUuids

Unique IDs of the alerts for which you want to change their status.

NOTE: The alert UUID is unique per CVE and therefore different for all the vulnerabilities related to the same library.

array

Yes

comments

Free text comment describing why the alerts should be changed.

string

No

status

Current status of the alert(s): Active or Ignored.

string

Yes