Tenable Scans API
The Scans API from Tenable — 11 operation(s) for scans.
Tenable Scans API is one of 107 APIs that Tenable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Scans. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 17 operations across 11 paths, and defines 59 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://www.tenable.com/downloads/api/v2.
17 operations
11 paths
59 schemas
2 DELETE7 GET1 PATCH5 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tenable Scans API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
By default, every request must be authenticated.
Bearer— Example: Bearer {{token}}
Paths & Operations 17
Across 11 paths, the API surfaces 17 operations — 2 DELETE, 7 GET, 1 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Scans 17
GET
/pci-asv/scans/list
List PCI scans
POST
/scans
Create scan
GET
/scans
List scans
GET
/scans/{scan_id}
Get scan details
PUT
/scans/{scan_id}
Update scan
DELETE
/scans/{scan_id}
Delete scan
POST
/was/v2/configs/{config_id}/scans
Launch scan
POST
/api/v3/was/import
Import scan
POST
/was/v2/configs/{config_id}/scans/search
Search scans
GET
/was/v2/scans/{scan_id}
Get scan details
PATCH
/was/v2/scans/{scan_id}
Update scan status
DELETE
/was/v2/scans/{scan_id}
Delete scan
GET
/was/v2/scans/{scan_id}/notes
Get scan notes
POST
/was/v2/scans/{scan_id}/vulnerabilities/search
Search vulnerabilities for scan
PUT
/was/v2/scans/{scan_id}/report
Export scan results
GET
/was/v2/scans/{scan_id}/report
Download exported scan
GET
/api/v3/export/{scan_id}
Download debug ZIP file
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are scans_Request-ScanSettings-Assessment (57 properties), scans_Request-ScanSettings-Advanced (54 properties), scans_scan-object-create-update-response (38 properties), scans_Request-ScanSettings-Discovery (34 properties). Each schema is shown below with its type and property counts.
scans_Request-ScanSettings-Discovery
object
Settings that control how the scanner discovers hosts, including host discovery, ping methods, port scanning, service discovery, and identity collection.
34 properties
Response-PaginationSortObject
object
An object specifying how the current result set is sorted, including the property by which the results were sorted and the sort direction.
2 properties
PluginSettings
object
The settings for enabling or disabling individual plugins and/or plugin families to customize your scan.
5 properties
AuditSettings
object
The settings that allow the scan to audit elements other than the ones detected during crawling.
14 properties
scans_history-in-scan-details-response
object
11 properties
VulnerabilityDetails
object
The details for the vulnerability.
8 properties
ReportScan
object
4 properties
AppliedFilters-Scans
object
A single filter to apply to the scan search.
3 properties
ReportConfig
object
7 properties
ReportInfo
object
8 properties
scans_scan-info-response-object
object
29 properties
HttpSettings
object
The HTTP request settings for the scan.
7 properties
scans_vulnerability
object
7 properties
ErrorResponse
object
3 properties
Credentials
object
The credentials the scanner uses to run an authenticated scan against the web application. For more information, see the managed credentials category in [Manag…
1 property
1 required
ReportScanSettings
object
9 properties
Response-ScansList
object
12 properties
scans_host
object
15 properties
scans_request-update-scan-credentials-object
object
An object that specifies credential parameters that enable a scanner to authenticate a connection to a target host. For more information about using managed cr…
3 properties
scans_Request-ScanSettings-Schedule
object
Settings that control when and how often the scan runs.
7 properties
scans_settings-scan-triggers
array
For Nessus Agent scans, describes the scan triggers used when agentscanlaunchtype is set to triggered.
scans_Request-ScanSettings-Basic
object
Basic scan configuration settings including name, description, targets, scanner assignment, and notifications.
30 properties
1 required
scans_Request-ScanSettings-Report
object
Settings that control how scan results are reported and displayed.
7 properties
RequestedAction
string
scans_Request-ScanSettings-Assessment
object
Settings that control vulnerability assessment behavior including accuracy, brute force, SCADA, web application scanning, Windows enumeration, malware scanning…
57 properties
scans_request-create-and-update-plugins-object
object
A list of plugins to add to the non-remediation scans. Use the [List plugin families](ref:io-plugins-families-list) endpoint to get a list of plugin families t…
1 property
scans_settings-agent-scan-launch-type
string
For Nessus Agent scans, indicates whether the agent scan should use the scan window (scheduled) or rule-based (triggered) method for scan launches.
ScanStatus
string
The scan status. Values include: - aborted—Terminated before completion for reason other than a user-requested stop. - canceled—Stopped by a user request. - co…
ReportFindings
object
AssessmentSettings
object
Assessment settings specify which web application elements you want the scanner to audit as it crawls your URLs.
5 properties
ScanReport
object
2 properties
PaginationResponse
object
An object containing pagination information for the current result set.
4 properties
scans_scan-object-list
object
24 properties
Attachment
object
The report attachments for the vulnerability.
5 properties
5 required
scans_filter
object
4 properties
Vulnerability
object
7 properties
7 required
ReportScanTemplate
object
3 properties
BrowserSettings
object
The settings for the virtual browser instance used by the scanner.
6 properties
ScopeSettings
object
The URLs and file types that you want to include or exclude from your scan.
22 properties
PaginationResponseSortObject
object
An object specifying how the current result set is sorted, including the property by which the results were sorted and the sort direction.
2 properties
ReportScanNotes
object
NessusScanReport
object
scans_Request-ScanSettings-Advanced
object
Settings that control general scan behavior, performance, debugging, compliance output, vulnerability options, and credential handling.
54 properties
scans_scan-object-create-update-response
object
38 properties
ScanMetadata
object
Summary statistics for the scan results.
8 properties
scans_settings-acls
object
6 properties
scans_settings-rrules
string
The interval at which the scan repeats. The interval is formatted as a string of three values delimited by semi-colons. These values are: the frequency (FREQ=O…
Scan
object
11 properties
10 required
scans_note
object
3 properties
scans_Request-ScanSettings
object
Complete scan settings for creating or updating a scan configuration.
ScanNote
object
A note describing error conditions the scanner encountered for a given scan.
6 properties
scans_request-create-scan-credentials-object
object
An object that specifies credential parameters that enable a scanner to authenticate a connection to a target host. For more information about using managed cr…
1 property
ReportUserScanTemplate
object
3 properties
Response-Pagination
object
An object containing pagination information for the current result set.
4 properties
scans_Request-ScanAudits
object
Specifies compliance audit files to include in the scan. Supports both Tenable-provided (feed) audits and user-uploaded (custom) audits. For more information,…
2 properties
scans_ErrorResponse
object
3 properties
AppliedFilters-Vulnerabilities
object
A single filter to apply to the vulnerabilities search.
3 properties
ErrorResponse_2
object
Tenable Web App Scanning error response.
1 property
1 required
AppliedFilters-VulnerabilitiesByScan
object
A single filter to apply to the vulnerabilities search for the specified scan.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tenable 12
Other APIs Tenable publishes across the network.
Tenable About API
Tenable Access Control (API) API
Tenable Access Control (Groups) API
Tenable Access Control (Permissions) API
Tenable Access Control (Roles) API
Tenable Access Control (Users) API
Tenable Access Groups v1 API
Tenable Access Groups v2 API
Tenable Account Groups API
Tenable Accounts API
Tenable Activity Log API
Tenable AD object API
#Scans