TotalAppSec Release 2.12 | Web Application Scanning Release 1.32 API
november 03, 2026
This release adds API endpoints for launching, checking, and canceling web application retests, and for retrieving vault connection usage. It also moves scorecard CSV, CSV_V2, and XML reports to the new reporting framework, and adds scan settings fields that control which scan outcomes send a completion email.
New Feature
New APIs: Retest Web Applications
What's New for You
You can retest web applications through the API to verify that previously detected vulnerabilities have been remediated, matching what you can already do in the user interface. Retest at the finding level was already available; these endpoints add the same capability at the web application level.
- Retest Web Applications
POST rest/webapp/4.0/retest - Get Web Application Retest Status
POST rest/webapp/4.0/retest/status - Cancel Web Application Retest
POST rest/webapp/4.0/retest/cancel
All three endpoints take the same request body. Specify between 1 and 100 web applications.
| Field | Description |
|---|---|
applicationIds |
Required. The unique numeric identifiers of the web applications to launch, inspect, or cancel a retest on. Specify at least 1 and no more than 100. |
Launching and canceling return one entry per web application, so a single request can succeed for some applications and fail for others. Each entry carries the entityId, a status of SUCCESS, FAILED, DOES_NOT_EXIST, or PARTIAL_SUCCESS, and a reason.
New API: Retest Web Applications
| New or Updated APIs | New |
| API Endpoint (New version) | rest/webapp/4.0/retest |
| Method | POST |
| JSON Schema Changes | No |
Launches retest scans for the web applications you specify.
Sample: Retest Web ApplicationsSample: Retest Web Applications
API Request
{
"applicationIds": [
3687496
]
}
API Response
{
"entries": [
{
"entityId": 3687496,
"status": "SUCCESS",
"reason": "Retest scan launched successfully"
}
]
}
New API: Get Web Application Retest Status
| New or Updated APIs | New |
| API Endpoint (New version) | rest/webapp/4.0/retest/status |
| Method | POST |
| JSON Schema Changes | No |
Returns the latest retest scan for each web application you specify, including its status, when it started, and who launched it. The retest object is absent when no retest scan is available for that web application.
Sample: Get Web Application Retest StatusSample: Get Web Application Retest Status
API Request
{
"applicationIds": [
3687496
]
}
API Response
[
{
"id": 3687496,
"name": "UAT Application",
"retest": {
"retestStatus": "RUNNING",
"retestedDate": 1790904166000,
"retestedUser": {
"id": 101,
"username": "quays_appsec",
"firstName": "Appsec",
"lastName": "Qualys"
}
}
}
]
retestedDate is in Unix milliseconds since epoch.
New API: Cancel Web Application Retest
| New or Updated APIs | New |
| API Endpoint (New version) | rest/webapp/4.0/retest/cancel |
| Method | POST |
| JSON Schema Changes | No |
Cancels retest scans that are pending or running for the web applications you specify.
Sample: Cancel Web Application RetestSample: Cancel Web Application Retest
API Request
{
"applicationIds": [
3687496
]
}
API Response
{
"entries": [
{
"entityId": 3687496,
"status": "SUCCESS",
"reason": "Scan cancellation started successfully"
}
]
}
New Feature
New API: Vault Connection Usage
What's New for You
You can retrieve the usage details for a vault connection through the API, matching the Usage tab in the user interface. The response lists objects that reference the vault connection, such as authentication records, so you can assess the impact before editing or deleting it.
- Get Vault Connection Usage
GET rest/vaultConnection/1.0/usage/{vaultConnectionId}
New API: Get Vault Connection Usage
| New or Updated APIs | New |
| API Endpoint | rest/vaultConnection/1.0/usage/{vaultConnectionId} |
| Method | GET |
| JSON Schema Changes | No |
Returns the list of objects that use a vault connection, such as the authentication records that reference it. Use it to see which vault connection is currently in use before you edit or delete it.
Request parameters
| Parameter | Type | Description |
|---|---|---|
size |
Query | Optional. The maximum number of usage records to return per page. The default is 1000, and the valid range is 1 to 1000. For example, size=100. |
scrollInfo |
Query | Optional. The scroll token used to page through results. It is returned in the response only when more pages exist. Pass it back to fetch the next page. |
Response fields
| Field | Description |
|---|---|
id |
The ID of the object that uses the vault connection. |
objectType |
The type of the object that uses the vault connection. |
objectName |
The name of the object that uses the vault connection. |
objectOwner |
The owner of the object that uses the vault connection. |
lastUsed |
When the vault connection was last used by this object, in epoch milliseconds. |
lastStatus |
The outcome the last time this object used the vault connection. |
totalElements |
The total number of objects that use the vault connection. |
Results are returned in ascending order of id. Requesting usage for a vault connection ID that does not exist returns HTTP 404 Not Found, and an invalid scrollInfo value returns HTTP 400 Bad Request.
This endpoint is available to subscriptions that have TotalAppSec and vault support enabled. The existing vault connection create, read, update, delete, and search endpoints are unchanged.
Enhancement
Updated APIs: Scorecard Reports
What Changed For You
Scorecard reports requested in CSV, CSV_V2, and XML formats are now generated by the new reporting framework across the V4 public APIs. Web application and scan reports in these formats already used this framework; scorecard reports now follow the same path.
The request and response contracts remain unchanged, so no changes are required in existing integrations.
| New or Updated APIs | Updated |
| API Endpoints | rest/report/4.0 (V4) |
| Method | POST |
| JSON Schema Changes | No |
Creating a report with type set to WAS_SCORECARD_REPORT and format set to CSV, CSV_V2, or XML now uses the new reporting flow. The way you create the report, poll its status, and download it is unchanged.
Enhancement
Updated APIs: Scan Completion Email Preferences
What Changed For You
You can choose which scan outcomes send a completion email through the API. Three optional Boolean fields were added to the scan settings of single-scan launch, multi-scan launch, and scan schedule requests, across vulnerability, discovery, compliance, and authentication test scans.
| New or Updated APIs | Updated |
| API Endpoints | rest/scan/4.0/launch rest/scan/4.0/{id} rest/scan/4.0/relaunch rest/schedule/scan/4.0 rest/schedule/scan/4.0/{id} |
| Method | POST, GET, PUT |
| JSON Schema Changes | Yes |
The following optional Boolean fields were added to the scan settings object. All three are sub-filters of isSendEmailEnabled and apply only when it is true.
| Field | Description |
|---|---|
isSendEmailOnSuccessEnabled |
Set to true to send a completion email when a scan finishes successfully. |
isSendEmailOnFailureEnabled |
Set to true to send a completion email when a scan fails. |
isSendEmailOnCancelEnabled |
Set to true to send a completion email when a scan is canceled. |
Omitting a field leaves that outcome enabled, so requests from existing clients that do not send these fields continue to behave exactly as before. Setting isSendEmailEnabled to true while setting all three outcome fields to false is rejected with HTTP 400 Bad Request. When isSendEmailEnabled is false, the three outcome fields are ignored.
The saved preferences are returned by the corresponding GET requests, and are preserved when a scan is relaunched or when an unrelated field is updated on a schedule.
Sample: Send an Email Only for Failed ScansSample: Send an Email Only for Failed Scans
Scan settings fragment
{
"isSendEmailEnabled": true,
"isSendEmailOnSuccessEnabled": false,
"isSendEmailOnFailureEnabled": true,
"isSendEmailOnCancelEnabled": false,
"recipients": "[email protected]"
}
For multi-scan requests, scanFrequency set to ONE_PER_INDIVIDUAL_SCAN sends one email per application scan, and ONE_PER_MULTI_SCAN sends a single combined email for the multi-scan.
The outcome used to filter the email is the scan's final consolidated status, which accounts for result processing. A scan that finished but produced a terminal non-success result, such as no host alive, is treated as a failure. If you set only isSendEmailOnSuccessEnabled to true, you will no longer receive an email for these scans.