Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Tenable

Tenable Configurations API

With the Configurations API, you can create and maintain reusable scan settings. These endpoints allow you to perform standard CRUD operations on configuration objects to standardize scanning across your environment.For more information, see [Scan Templates](https://docs.tenable.com/web-app-scanning/Content/WAS/Scans/WASScanSettings.htm) in the _Tenable Web App Scanning User Guide_.

Documentation Provider Profile APIs.io OpenAPI GitHub

Tenable Configurations API is one of 107 APIs that Tenable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configurations. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 6 paths, and defines 34 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.

9 operations 6 paths 34 schemas 1 DELETE4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://cloud.tenable.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tenable Configurations 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 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Configurations 9

With the Configurations API, you can create and maintain reusable scan settings. These endpoints allow you to perform standard CRUD operations on configuration objects to standard…

POST
/was/v2/configs
Create scan configuration
was-v2-config-create body → 202400401403429500
GET
/api/v3/export/configs/remediation/{vuln_id}
Get remediation scan configuration
was-v3-config-remediation 1 param → 200401403404422429500
POST
/was/v2/configs/search
Search scan configurations
was-v2-config-search 3 params body → 200401429500
GET
/was/v2/configs/{config_id}
Get scan configuration details
was-v2-config-details 1 param → 200400401404429500
PUT
/was/v2/configs/{config_id}
Upsert scan configuration
was-v2-config-upsert 1 param body → 202400401429500
PATCH
/was/v2/configs/{config_id}
Move scan configuration
was-v2-config-move 1 param body → 200202400401404429500
DELETE
/was/v2/configs/{config_id}
Delete scan configuration
was-v2-config-delete 1 param → 202400401404409429500
GET
/was/v2/configs/{config_id}/status/{tracking_id}
Get scan configuration processing status
was-v2-config-status 2 params → 200401429500
GET
/api/v3/export/configs/{config_id}
Export scan configuration for CI/CD
was-v3-config-export-cicd 1 param → 200401403404429500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Response-Scan-Config (24 properties), ScopeSettings (22 properties), Request-Config (17 properties), ConfigMetadata (15 properties). Each schema is shown below with its type and property counts.

ConfigSettings
object
The scan configuration settings.
12 properties
Request-Config
object
17 properties 5 required
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
ErrorResponse
object
Tenable Web App Scanning error response.
1 property 1 required
ConfigUpdate
object
1 property 1 required
HttpSettings
object
The HTTP request settings for the scan.
7 properties
PauseWindow
object
3 properties 2 required
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
PauseWindowSchedule
object
7 properties
Notifications
object
Contact information used to send scan notifications upon scan completion.
1 property 1 required
ConfigMetadata
object
15 properties 6 required
PermissionLevel
string
The scan permissions level, as described in [Permissions](doc:permissions).
ScheduleWindowTime
object
2 properties 2 required
InputErrorResponse
object
Tenable Web App Scanning invalid input error response.
2 properties 2 required
RequestedAction
string
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…
ScheduleWindows
object
Defines scan and pause windows for scheduled scans. Each window specifies when scans run or pause. Schedule windows require a scan schedule to be enabled.
3 properties 3 required
AssessmentSettings
object
Assessment settings specify which web application elements you want the scanner to audit as it crawls your URLs.
5 properties
AppliedFilters-ScanConfigs
object
A single filter to apply to the scan configuration search.
3 properties
PaginationResponse
object
An object containing pagination information for the current result set.
4 properties
ScheduleWindowItem
object
3 properties 3 required
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
ScanMetadata
object
Summary statistics for the scan results.
8 properties
Scan
object
11 properties 10 required
FolderResponse
object
Folder data
2 properties 2 required
Permissions
object
4 properties 3 required
ScanSchedule
object
5 properties 3 required
ChromeScript
object
4 properties
ResultsVisibility
string
The visibility of the results (private or dashboard).
Response-Scan-Config
object
24 properties 12 required
PauseWindowDaySchedule
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tenable-configurations-api-openapi.yml Raw ↑

Other APIs Tenable publishes across the network.

Tenable About API
AE Profile APIs.io
Tenable Access Control (API) API
AE Profile APIs.io
Tenable Access Control (Groups) API
AE Profile APIs.io
Tenable Access Control (Permissions) API
AE Profile APIs.io
Tenable Access Control (Roles) API
AE Profile APIs.io
Tenable Access Control (Users) API
AE Profile APIs.io
Tenable Access Groups v1 API
AE Profile APIs.io
Tenable Access Groups v2 API
AE Profile APIs.io
Tenable Account Groups API
AE Profile APIs.io
Tenable Accounts API
AE Profile APIs.io
Tenable Activity Log API
AE Profile APIs.io
Tenable AD object API
AE Profile APIs.io
#Configurations
← Back to T APIs
API Details
ID
tenable:tenable-configurations-api
Base URL
https://cloud.tenable.com
Docs
https://developer.tenable.com/reference/navigate
Provider
Tenable
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network