Function: deleteVulnerabilitiesByProperty()

function deleteVulnerabilitiesByProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/agile/api/securityInformation.ts:142

Bulk delete all Vulnerabilities that match the given request.

One or more query params must be supplied to specify Properties to delete by. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND). Read the POST bulk endpoint documentation for more details.

E.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456

Deletion is performed asynchronously. The GET vulnerability endpoint can be used to confirm that data has been deleted successfully (if needed).

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; createdBy?: string; }	-
parameters.accountId	string	Property key used to select which submitted vulnerabilities to delete. Must match a key previously sent in submitVulnerabilities properties (string values, max 5 properties, keys cannot contain ':' or start with '_'). Example: accountId=account-123.
parameters.createdBy?	string	Optional additional property filter combined with accountId (AND). Must match a key previously supplied in submitVulnerabilities properties. Example: createdBy=user-456.
options?	RequestOptions	-

Returns

Promise<void>