Remove a URL scan from a Dynamic Analysis with the REST API
You can use the Dynamic Analysis API to delete a URL scan from an analysis.
To complete this task:
-
Send the following request to get a list of analyses by name:
http --auth-type=veracode_hmac GET "https://api.veracode.com/was/configservice/v1/analyses/"
-
Send the following request, where
name
is the name of the analysis you want to edit:http --auth-type=veracode_hmac GET "https://api.veracode.com/was/configservice/v1/analyses?name={name}"
-
Obtain the
analysis_id
of the analysis you want to edit. -
Send the following request to find the
scan_id
:http --auth-type=veracode_hmac GET "https://api.veracode.com/was/configservice/v1/analyses/{analysis_id}/scans"
-
Add the scan ID to the JSON file.
-
Ensure the
action_type
property is set toREMOVE
in the JSON file. -
Send the following request, where
analysis_id
is the ID of the analysis from which to delete the scan:http --auth-type=veracode_hmac PUT "https://api.veracode.com/was/configservice/v1/analyses/{analysis_id}?method=PATCH" < input.json
The API passes the JSON file that you populate with the necessary values as shown in this example payload:
{
"name": "Name-of-Your-Dynamic-Analysis",
"scans": [
{
"action_type": "REMOVE",
"scan_id": "{scan_id}"
}
]
}