Tenable Editor API
The Editor API from Tenable — 5 operation(s) for editor.
OpenAPI Specification
openapi: 3.0.0
info:
version: 1.0.0
title: Downloads About Editor API
description: 'The Downloads API enables customers to access and download installation and update files for available Tenable products. You can use the API endpoints to list product pages, list downloads available for a specific product, and to download a file. The endpoints can also be used to determine and download the latest version of a file to facilitate the automation of an installation.
**Note:** The Tenable Downloads API uses a different server URL than the Tenable Vulnerability Management API:
`https://www.tenable.com/downloads/api/v2/pages`.
### Authentication
Like the Downloads website, certain files require authentication to download. When files have a `"requires_auth": true` attribute on the product list page, the Downloads API uses bearer token authentication and requires a valid token in the Authorization header to download the file:
```
Authorization: Bearer AbCdEf123456
```
To access or reset your authentication token, navigate to the [Authentication Token](https://www.tenable.com/downloads/api-docs) page.
Examples of product downloads that **do not** require authentication include Nessus and Nessus Agents.'
servers:
- url: https://www.tenable.com/downloads/api/v2
security:
- Bearer: []
tags:
- name: Editor
x-displayName: Editor
paths:
/editor/{type}/{id}:
get:
summary: Get configuration details
description: 'Gets the configuration details for the scan or user-defined template (policy).
**Note:** The returned attributes can vary depending on the Tenable-provided template used to create the scan or user-defined template (policy).<div class="perms-callout">Requires the Standard [32] user role. See [Roles](doc:roles).</div>'
operationId: editor-details
tags:
- Editor
parameters:
- description: The type of object (`scan` or `policy`).
required: true
name: type
in: path
schema:
type: string
default: scan
enum:
- scan
- policy
- description: The unique ID of the scan or user-defined template (policy).
required: true
name: id
in: path
schema:
type: integer
format: int32
responses:
'200':
description: Returned if the object data was retrieved successfully. The returned attributes can vary depending on the Tenable-provided template used to create the scan or user-defined template (policy).
content:
application/json:
schema:
type: object
properties:
is_was:
type: boolean
description: Indicates whether the scan or user-defined template (policy) can be used in Tenable Web App Scanning.
user_permissions:
type: integer
description: The scan or policy permissions that the requesting user has for the specified scan or user-defined template (policy). For more information, see [Permissions](doc:permissions).
owner:
type: string
description: The username of the owner of the scan or user-defined template (policy).
title:
type: string
description: 'For scans, the standard text, `Custom Scan`. For user-defined templates (policies), the name of the Tenable-provided template used to create the user-defined template. '
is_agent:
type: boolean
description: Indicates whether the scan or user-defined template (policy) can be used for agent scans.
uuid:
type: string
description: The UUID of the scan or user-defined template (policy).
filter_attributes:
type: array
items:
$ref: '#/components/schemas/editor_filter'
settings:
$ref: '#/components/schemas/editor_settings'
credentials:
$ref: '#/components/schemas/editor_credentials'
compliance:
$ref: '#/components/schemas/editor_compliance'
plugins:
$ref: '#/components/schemas/editor_plugins'
name:
type: string
description: For scans, the standard text, `custom`. For user-defined templates (policies), the system name for the Tenable-provided template used to create the scan or user-defined template.
examples:
response:
value:
is_was: null
user_permissions: 128
owner: user2@example.com
title: Custom Scan
is_agent: null
uuid: 04a0d852-0dc2-4e62-874d-a81e33b4a9f24e51e1f403febe40
settings:
basic:
inputs:
- type: entry
name: Name
id: name
default: KitchenSinkScan
required: true
- type: textarea
name: Description
id: description
default: null
- type: select
id: include_aggregate
name: Scan results
default: true
options:
- name: Show in dashboard
value: 'true'
- type: select
id: folder_id
name: Folder
default: 9
options:
- name: My Scans
id: 9
- name: Trash
id: 8
- type: select
id: use_dashboard
name: Dashboard
default: false
options:
- name: Enabled
value: 'true'
- name: Disabled
value: 'false'
title: Basic
groups:
- title: Permissions
name: permissions
acls:
- permissions: 0
owner: null
display_name: null
name: null
id: null
type: default
- permissions: 128
owner: 1
display_name: user2@example.com
name: user2@example.com
id: 2
type: user
sections: []
filter_attributes:
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: NUMBER
type: entry
regex: ^[0-9]+$
maxlength: 18
name: bid
readable_name: Bugtraq ID
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_framework_canvas
readable_name: CANVAS Exploit Framework
- operators:
- eq
- neq
control:
type: dropdown
list:
- CANVAS
- D2ExploitPack
- White_Phosphorus
name: canvas_package
readable_name: CANVAS Package
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'Cert VU reference (ie: 10031)'
type: entry
regex: ^[0-9]+$
maxlength: 18
name: cert
readable_name: CERT Vulnerability ID
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_framework_core
readable_name: CORE Exploit Framework
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: cpe
readable_name: CPE
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'CVE-YYYY-ID (ie: CVE-2011-0018)'
type: entry
regex: ^(CVE|CAN)-(1999|20[01][0-9])-[0-9]{4,}$
name: cve
readable_name: CVE
- operators:
- lt
- gt
- eq
- neq
- match
- nmatch
control:
readable_regex: '7.5'
type: entry
regex: ^[0-9]+(\.[0-9]+)?$
name: cvss_base_score
readable_name: CVSS Base Score
- operators:
- lt
- gt
- eq
- neq
- match
- nmatch
control:
readable_regex: '4.2'
type: entry
regex: ^[0-9]+(\.[0-9]+)$
name: cvss_temporal_score
readable_name: CVSS Temporal Score
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: ^CVSS2#E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$
name: cvss_temporal_vector
readable_name: CVSS Temporal Vector
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: ^CVSS2#AV:(L|A|N)/AC:(H|M|L)/Au:(N|S|M)/C:(N|P|C)/I:(N|P|C)/A:(N|P|C)$
name: cvss_vector
readable_name: CVSS Vector
- operators:
- lt
- gt
- eq
- neq
- match
- nmatch
control:
readable_regex: '7.5'
type: entry
regex: ^[0-9]+(\.[0-9]+)?$
name: cvss3_base_score
readable_name: CVSS v3.0 Base Score
- operators:
- lt
- gt
- eq
- neq
- match
- nmatch
control:
readable_regex: '4.2'
type: entry
regex: ^[0-9]+(\.[0-9]+)$
name: cvss3_temporal_score
readable_name: CVSS v3.0 Temporal Score
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: ^CVSS:3.0/E:(U|POC|F|H|ND)/RL:(OF|T|W|U|ND)/RC:(UC|UR|C|ND)$
name: cvss3_temporal_vector
readable_name: CVSS v3.0 Temporal Vector
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: ^CVSS:3.0/AV:(N|A|L|P)/AC:(L|H)/PR:(N,L,H)/UI:(N|R)/S:(U|C)/C:(H|L|N)/I:(H|L|N)/A:(H|L|N)$
name: cvss3_vector
readable_name: CVSS v3.0 Vector
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'CWE reference (ie: 200)'
type: entry
regex: ^([0-9]+)$
name: cwe
readable_name: CWE
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: default_account
readable_name: Default/Known Accounts
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_framework_d2_elliot
readable_name: Elliot Exploit Framework
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: d2_elliot_name
readable_name: Elliot Exploit Name
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_available
readable_name: Exploit Available
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: NUMBER
type: entry
regex: ^[0-9]+$
maxlength: 18
name: edb-id
readable_name: Exploit Database ID
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_framework_exploithub
readable_name: ExploitHub
- operators:
- eq
- neq
control:
type: dropdown
list:
- Exploits are available
- No exploit is required
- No known exploits are available
name: exploitability_ease
readable_name: Exploitability Ease
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploited_by_malware
readable_name: Exploited By Malware
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploited_by_nessus
readable_name: Exploited By Nessus
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'IAVA reference (ie: 2011-A-0151)'
type: entry
regex: ^[0-9]+-[A-Za-z]-[0-9]+$
name: iava
readable_name: IAVA ID
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'IAVB reference (ie: 2011-B-0151)'
type: entry
regex: ^[0-9]+-[A-Za-z]-[0-9]+$
name: iavb
readable_name: IAVB ID
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'IAVM Severity (ie: IV)'
type: entry
regex: ^[ivIV]+
name: stig_severity
readable_name: IAVM Severity
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: 'IAVT reference (ie: 2011-A-0151)'
type: entry
regex: ^[0-9]+-[A-Za-z]-[0-9]+$
name: iavt
readable_name: IAVT ID
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: in_the_news
readable_name: In The News
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: malware
readable_name: Malware
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: exploit_framework_metasploit
readable_name: Metasploit Exploit Framework
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: metasploit_name
readable_name: Metasploit Name
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: MS0X-YZT
type: entry
regex: ^MS[0-9]+-[0-9]+$
name: msft
readable_name: Microsoft Bulletin
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: NUMBER
type: entry
regex: ^[0-9]+$
maxlength: 18
name: osvdb
readable_name: OSVDB ID
- operators:
- date-lt
- date-gt
- date-eq
- date-neq
control:
readable_regex: YYYY/MM/DD
type: datefield
regex: ^[0-9]{4}/[0-9]{2}/[0-9]{2}$
name: patch_publication_date
readable_name: Patch Publication Date
- operators:
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: description
readable_name: Plugin Description
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: NUMBER
type: entry
regex: ^[0-9, ]+$
maxlength: 9
name: plugin_id
readable_name: Plugin ID
- operators:
- date-lt
- date-gt
- date-eq
- date-neq
control:
readable_regex: YYYY/MM/DD
type: datefield
regex: ^[0-9]{4}/[0-9]{2}/[0-9]{2}$
name: plugin_modification_date
readable_name: Plugin Modification Date
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: plugin_name
readable_name: Plugin Name
- operators:
- date-lt
- date-gt
- date-eq
- date-neq
control:
readable_regex: YYYY/MM/DD
type: datefield
regex: ^[0-9]{4}/[0-9]{2}/[0-9]{2}$
name: plugin_publication_date
readable_name: Plugin Publication Date
- operators:
- eq
- neq
control:
type: dropdown
list:
- local
- remote
name: plugin_type
readable_name: Plugin Type
- operators:
- eq
- neq
control:
type: dropdown
list:
- None
- Low
- Medium
- High
- Critical
name: risk_factor
readable_name: Risk Factor
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: NUMBER
type: entry
regex: ^[0-9]+$
maxlength: 18
name: secunia
readable_name: Secunia ID
- operators:
- eq
- neq
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: see_also
readable_name: See Also
- operators:
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: solution
readable_name: Solution
- operators:
- match
- nmatch
control:
readable_regex: TEXT
type: entry
regex: .*
name: synopsis
readable_name: Synopsis
- operators:
- eq
- neq
control:
type: dropdown
list:
- 'true'
- 'false'
name: unsupported_by_vendor
readable_name: Unsupported By Vendor
- operators:
- date-lt
- date-gt
- date-eq
- date-neq
control:
readable_regex: YYYY/MM/DD
type: datefield
regex: ^[0-9]{4}/[0-9]{2}/[0-9]{2}$
name: vuln_publication_date
readable_name: Vulnerability Publication Date
name: custom
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/editor_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to open the object.
'404':
description: Returned if Tenable Vulnerability Management cannot find the specified object.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"
'500':
description: Returned if an internal error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/editor_ErrorResponse'
examples:
response:
value:
statusCode: 500
error: Internal Server Error
message: An internal server error occurred. Please wait a moment and try your request again.
security:
- editor_cloud: []
/editor/{type}/templates:
get:
summary: List templates
description: Lists Tenable-provided scan templates. Tenable provides a number of scan templates to facilitate the creation of scans and scan policies. For a full description of these scan templates, see the [Scan Templates](https://docs.tenable.com/vulnerability-management/Content/Scans/Templates.htm) in the Tenable Vulnerability Management User Guide. <div class="perms-callout">Requires the Standard [32] user role. See [Roles](doc:roles).</div>
operationId: editor-list-templates
tags:
- Editor
parameters:
- description: The type of templates to retrieve (scan, policy, or remediation).
required: true
name: type
in: path
schema:
type: string
default: scan
enum:
- scan
- policy
- remediation
responses:
'200':
description: Returns the template list.
content:
application/json:
schema:
$ref: '#/components/schemas/editor_templates'
examples:
response:
value:
templates:
- unsupported: false
cloud_only: false
desc: A full system scan suitable for any host.
order: null
subscription_only: false
is_was: null
title: Basic Network Scan
is_agent: null
uuid: aa17696a-f0ad-458a-a103-973c8f63752a7bd788d6be818b65
manager_only: false
name: basic
- unsupported: false
cloud_only: false
desc: Audit systems connected via Nessus Agents.
order: null
subscription_only: false
is_was: null
title: Policy Compliance Auditing
is_agent: true
uuid: 54a0c38a-9deb-4ed6-833c-525e01cb0c8ed9c901634c382c2d
manager_only: false
name: agent_compliance
- unsupported: false
cloud_only: false
desc: Scan for malware on systems connected via Nessus Agents.
order: null
subscription_only: false
is_was: null
title: Malware Scan
is_agent: true
uuid: cb0d8586-af21-4d52-96a8-a12acaac4132621fbb0e783517bc
manager_only: false
name: agent_malware
'401':
description: Returned if the API keys specified in your request are invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/editor_ErrorResponse'
examples:
response:
value:
statusCode: 401
error: Unauthorized
message: Invalid credentials.
'403':
description: Returned if you do not have permission to view the list.
'429':
description: Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](doc:rate-limiting).
content:
text/html:
examples:
response:
value: "<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 To
# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tenable/refs/heads/main/openapi/tenable-editor-api-openapi.yml