Web Application Scanning v2: Deprecation Reminders
There are several endpoints, parameters, and attributes in the Web Application Scanning v2 API that are pending deprecation. These items will be removed on November 18th, 2021. Please update any existing integrations that your organization has before this date.
All items pending deprecation are outlined below.
Deprecated details.response and details.request response attributes
The details.response and details.request response attributes are deprecated. These response attributes will be retired from the the Web Application Scanning v2 API on 2021/11/18 and will no longer be returned in responses. Please update any existing integrations that your organization has.
See previous deprecation announcement.
Warning
The
details.responseanddetails.requestresponse attributes will be removed on November 18th, 2021. Please update any existing integrations that your organization has before this date.
This update affects the following endpoints:
| Endpoint | Name | Change |
|---|---|---|
| POST /was/v2/scans/scan_id/vulnerabilities/search | Search vulnerabilities for scan | The details.response and details.request response attributes are deprecated. |
| GET /was/v2/vulnerabilities/{vuln_id}/{config_id} | Get vulnerability details | The details.response and details.request response attributes are deprecated. |
| POST /was/v2/vulnerabilities/search | Search vulnerabilities | The details.response and details.request response attributes are deprecated |
Deprecated list endpoints
The advanced search and filtering feature as described in Web Application Scanning: Advanced Search and Filtering has introduced new POST method endpoints that are intended to replace the older GET method endpoints.
See previous deprecation announcement.
Warning
On November 18th 2021, documentation related to the endpoints described in the table below will be removed from the Tenable developer portal. Tenable recommends that you use the new POST method endpoints with the advanced search and filtering feature instead. Please update any existing integrations that your organization has before 2021-11-18.
The deprecated endpoints are described in the table below:
| Deprecated Endpoint | Name | Description |
|---|---|---|
| GET /was/v2/configs | List scan configurations | Tenable recommends that you use the POST /was/v2/configs/search endpoint instead. |
| GET /was/v2/scans | List scans | Tenable recommends that you use the POST /was/v2/configs/{config_id}/scans/search endpoint instead. |
| GET /was/v2/user-templates | List user-defined templates | Tenable recommends that you use the POST /was/v2/user-templates/search endpoint instead. |
| GET /was/v2/vulnerabilities | List vulnerabilities | Tenable recommends that you use the POST /was/v2/vulnerabilities/search endpoint instead. |
| GET /was/v2/scans/{scan_id}/vulnerabilities | List vulnerabilities for scan | Tenable recommends that you use the POST /was/v2/scans/{scan_id}/vulnerabilities/search endpoint instead. |
Deprecation due to pagination update
The Tenable.io Web Application Scanning v2 API page request and response format was updated to match the Tenable.io Vulnerability Management format. This change brings consistent pagination across the various Tenable.io APIs. The old page request and response format has been deprecated in favor of the new page request and response format.
See previous deprecation announcement.
Warning
The old page request and response format has been deprecated. Backwards compatibility and support for both formats will remain until November 18th, 2021. Please update any existing integrations that your organization has before this date.
Deprecated application_uri parameter
The application_uri query parameter has been deprecated in favor of the asset_id parameter. Tenable recommends that you use the asset_id parameter for filtering instead. This change affects the GET /was/v2/vulnerabilities endpoint.
See previous deprecation announcement.
Warning
These deprecated items will be removed on November 18th, 2021. Please update any existing integrations that your organization has before this date.
This update affects the following endpoints:
| Endpoint | Parameter | Change |
|---|---|---|
| POST /was/v2/configs | settings.target | Deprecated, Tenable recommends that you use the target parameter in the main request body instead. |
| PUT /was/v2/configs/{config_id} | settings.target | Deprecated, Tenable recommends that you use the target parameter in the main request body instead. |
| GET /was/v2/vulnerabilities | application_uri | Deprecated, Tenable recommends that you use the asset_id parameter instead. |
Limit parameter upper bound
The limit parameter used to specify the number of records to retrieve will have an upper bound limit of 200 effective November 18th, 2021. If you need to retrieve more than 200 records, use the offset value to iterate through page responses.
Warning
A maximum value of 200 will be enforced for the
limitparameter on November 18th, 2021. Please update any existing integrations that your organization has before this date.