Jump to Content
Documentation
API Explorer
Recipes
Community
Changelog
RSS
Subscribe
Home
Documentation
Recipes
API Explorer
Changelog
Discussions
Documentation
API Explorer
Recipes
Community
Changelog
RSS
Subscribe
Log In
API Explorer
Log In
API Explorer
Get all users
Search
JUMP TO
Get Started
Navigate the APIs
Read the Docs
Disclaimer
Download the Specs
Try It!
Tenable Platform & Settings
Access Control (API)
List allowed IP addresses
get
Update allowed IP addresses
put
Access Control (Groups)
Create group
post
List groups
get
Update group
put
Delete group
delete
List users in group
get
Add user to group
post
Access Control (Permissions)
Create permission
post
List permissions
get
Get permission details
get
Update permission
put
Delete permission
delete
List user permissions
get
List user group permissions
get
Get current user permissions
get
Access Control (Users)
Create user
post
List users
get
Get user details
get
Update user
put
Delete user
delete
Get user role
get
Delete user from group
delete
Change user role
put
Change password
put
Enable user account
put
Get user authorizations
get
Update user authorizations
put
Generate API keys
put
Impersonate user
post
Send verification code
post
Validate verification code
post
Configure two-factor authentication
put
Access Groups v1
Create access group
post
List access groups
get
Update access group
put
Delete access group
delete
Get access group details
get
List access group filters
get
List asset rule filters
get
Access Groups v2
Create access group
post
List access groups
get
Update access group
put
Delete access group
delete
Get access group details
get
List access group filters
get
List asset rule filters
get
Activity Log
View activity log
get
Agents
List agents
get
List agents by group
get
Get agent details
get
Rename agent
patch
Unlink agent
delete
Agent Bulk Operations
Add agents to a group
post
Add agents to a network
post
Agent profile operations
post
Check agent group operation status
get
Check agent operation status
get
Send instructions to agents
post
Send instructions to agents group
post
Remove agents from group
post
Remove agents from network
post
Unlink agents
post
Agent Config
Get agent configuration
get
Update agent configuration
put
Agent Exclusions
Create agent exclusion
post
List agent exclusions
get
Get agent exclusion details
get
Update agent exclusion
put
Delete agent exclusion
delete
Agent Groups
Create agent group
post
List agent groups
get
Get agent group details
get
Update agent group name
put
Delete agent group
delete
Add agent to group
put
Remove agent from group
delete
Agent Profiles
Create profile
post
List profiles
get
Get profile details
get
Update profile
put
Delete profile
delete
Clone profile
post
Cloud Connectors
Create connector
post
List connectors
get
Get connector details
get
Update connector
put
Delete connector
delete
Download ARM Template
get
Download CFT Template
post
List AWS cloudtrails
post
Import data
post
Credentials
Create managed credential
post
List managed credentials
get
Get managed credential details
get
Update managed credential
put
Delete managed credential
delete
List credential types
get
Upload credentials file
post
Exclusions
Create exclusion
post
List exclusions
get
Import exclusion
post
Get exclusion details
get
Update exclusion
put
Delete exclusion
delete
Networks
Create network
post
List networks
get
Get network details
get
Update network
put
Delete network
delete
Get network asset count
get
Assign scanners
post
List network scanners
get
Bulk assign scanners
post
List assignable scanners
get
OT Connectors
Create OT connector
post
List OT connectors
get
Get OT connector details
get
Update OT connector
put
Delete OT connector
delete
Generate linking key
post
Permissions
Get object permissions
get
Update object permissions
put
Scanners
List scanners
get
Get scanner details
get
Update scanner
put
Delete scanner
delete
Get scanner key
get
List AWS scan targets
get
List running scans
get
Send instructions to scanner
post
Send instructions to multiple scanners
post
Allow control of running scans
post
Toggle scanner link state
put
Scanner Groups
Create scanner group
post
List scanner groups
get
List scanner group details
get
Update scanner group
put
Delete a scanner group
delete
List scanners within scanner group
get
Add scanner to scanner group
post
Remove scanner from scanner group
delete
List scan routes
get
Update scan routes
put
Server
Get server status
get
List server properties
get
Tags
Create tag category
post
List tag categories
get
Get category details
get
Update tag category
put
Delete tag category
delete
Create tag value
post
List tag values
get
Get tag value details
get
Update tag value
put
Delete tag value
delete
List tags for an asset
get
Add or remove asset tags
post
Bulk delete tag values
post
List asset tag filters
get
Target Groups
Create target group
post
List target groups
get
Get target group details
get
Update target group
put
Delete target group
delete
Vulnerability Management
Assets
List assets
get
Get asset details
get
Update ACR
post
Move assets
post
Bulk delete assets
post
Import assets
post
List asset import jobs
get
Get import job status
get
Asset Attributes
Create attribute
post
List attributes
get
Update attribute
put
Delete attribute
delete
Assign attributes to asset
put
List attributes assigned to asset
get
Delete attributes from asset
delete
Assign single attribute to asset
put
Delete attribute from asset
delete
Editor
Get configuration details
get
List templates
get
Get template details
get
Get plugin details
get
Download audit file
get
Exports (Assets)
Export assets v1
post
Export assets v2
post
Get assets export status
get
List asset export jobs
get
Download assets chunk
get
Cancel asset export
post
Exports (Compliance Data)
Export compliance data
post
Get compliance export status
get
List compliance export jobs
get
Download compliance chunk
get
Cancel compliance export
post
Exports (Vulnerabilities)
Export vulnerabilities
post
Get vulnerability export status
get
List vuln export jobs
get
Download vulnerabilities chunk
get
Cancel vuln export
post
File
Upload file
post
Filters
List agent filters
get
List asset filters
get
List asset filters v2
post
List credential filters
get
List report filters
get
List scan filters
get
List scan history filters
get
List vulnerability filters
get
List vulnerability filters v2
post
Folders
Create folder
post
List folders
get
Rename folder
put
Delete folder
delete
Plugins
List plugins
get
Get plugin details
get
List plugin families
get
List plugins in family (ID)
get
List plugins in family (name)
post
Policies
Create policy
post
List policies
get
Copy policy
post
Import policy
post
Export policy
get
List policy details
get
Update policy
put
Delete policy
delete
Reports
Create report
post
Get report status
get
Download report
get
Scans
Create scan
post
List scans
get
Get scan details
get
Update scan
put
Delete scan
delete
Scan Control
Launch scan
post
Pause scan
post
Resume scan
post
Stop scan
post
Force stop scan
post
Scan Exports
Export scan
post
Check scan export status
get
Download exported scan
get
Scan History
Get scan history
get
Get scan history details
get
Delete scan history
delete
Scan Results
Get host details
get
Get plugin output
get
Get scan attachment file
get
Scan Status
Get latest scan status
get
Update scan status
put
Get scan progress
get
Scan Tasks
Enable schedule
put
Copy scan
post
Convert credentials
post
Import uploaded scan
post
Get scan count
get
Get timezones
get
Test scan routes
post
Shared Collections
Create shared collection
post
List shared collections
get
Get shared collection details
get
Update shared collection
put
Delete shared collection
delete
Get shared collection details by name
post
Get job status
get
Add scan configs to shared collection
post
List scan configs in shared collection
get
Remove scan configs from shared collection
delete
Remediation Scans
Create remediation scan
post
List remediation scans
get
Vulnerabilities
Import vulnerabilities v1
post
Import vulnerabilities v2
post
Workbenches
List vulnerabilities
get
Get plugin details
get
List plugin outputs
get
List assets
get
List assets with vulnerabilities
get
Get asset information
get
Get asset activity log
get
List asset vulnerabilities
get
Get asset vulnerability details
get
List asset vulnerabilities for plugin
get
Delete asset
delete
Export workbench
get
Check export status
get
Download export file
get
Web App Scanning
Attachments
Download attachment
get
Configurations
Create scan configuration
post
Get remediation scan configuration
get
Search scan configurations
post
Get scan configuration details
get
Upsert scan configuration
put
Move scan configuration
patch
Delete scan configuration
delete
Get scan configuration processing status
get
Export scan configuration for CI/CD
get
Exports
Export findings
post
Get findings export status
get
List findings export jobs
get
Download findings export chunk
get
Cancel findings export
post
Filters
List scan configuration filters
get
List scan filters
get
List user-defined template filters
get
List vulnerability filters
get
List vulnerability filters for scan
get
Folders
Create folder
post
List folders
get
Rename folder
put
Delete folder
delete
Plugins
List plugins
get
Get plugin details
get
Scans
Launch scan
post
Import scan
post
Search scans
post
Get scan details
get
Update scan status
patch
Delete scan
delete
Get scan notes
get
Search vulnerabilities for scan
post
Export scan results
put
Download exported scan
get
Download debug ZIP file
get
Templates
List Tenable-provided templates
get
Get Tenable-provided template details
get
Search user-defined templates
post
Get user-defined template details
get
Update user-defined template
put
Delete user-defined template
delete
Vulnerabilities
Get vulnerability details
get
Search vulnerabilities
post
Exposure Management
Attack Path
List attack paths
get
List findings
get
Inventory
Search assets
post
Search software
post
List asset properties
get
List software properties
get
Tags
Search tags
post
List tag properties
get
PCI ASV
Attestations
List attestations
get
Get attestation details
get
List attestation disputes
get
List undisputed failures
get
List attestation assets
get
Scans
List PCI scans
get
MSSP
Accounts
Create evaluation account v1
post
Create evaluation account v2
post
Create quote
post
List child accounts
get
Get child account details
get
List domains
get
Account Groups
Create account group
post
List account groups
get
Get account group details
get
Update account group
put
Delete account group
delete
Child Containers
Generate auth keys for child container
post
List child containers
get
Get child container history
get
Dashboards
Get widget details
get
Domains
Add domain
post
List domains
get
Get domain details
get
Update domain
put
Send activation code
post
Filters
List account filters
get
License
Get license details
get
Logos
Add logo
post
List logos
get
Get logo details
get
Update logo
patch
Delete logo
delete
Assign logo
put
Download logo (PNG)
get
Download logo (Base64)
get
Partners
Get partner details
get
Resource Links
Bulk add resource links
post
Add resource links
post
List resource links
get
Downloads API
Downloads
List product pages
get
List downloadable files for a product
get
Download a file
get
Identity Exposure
About
Get about singleton.
get
AD object
Return the last state of every ad-object at the provided timestampBy default, the timestamp is now. Objects out of scope are included
get
Get ad-object instance by id.
get
Get ad-object instance by id.
get
Retrieve an AD object by id that have deviances for a specific profile and checker
get
Get one ad-object by event and by id
get
Get one ad-object changes between a given event and the event which precedes it
get
Search all AD objects having deviances by profile by checker
post
Alert
Get alert instance by id.
get
Update alert instance.
patch
Retrieve all alert instances.
get
Update alerts for one profile
patch
API key
Get the API key of the current user
get
Create or renew an API key for the current user
post
Application setting
Get the application settings
get
Update the application settings
patch
Attack
Get all attacks
get
Get all attacks in CSV rows format
get
Attack type
Get attack types
get
Attack type configuration
Get the attack type configuration
get
Update the attack type configuration
patch
Attack type option
Get all the attack type options related to a profile and attack type.
get
Create attack type options related to a profile and attack type.
post
Category
Retrieve all category instances.
get
Get category instance by id.
get
Checker
Retrieve all checker instances.
get
Get checker instance by id.
get
Checker option
Get all the checker options related to a profile and checker.
get
Create checker options related to a profile and checker.
post
Cloud statistics
Get user info needed to send cloud statistics.
get
Dashboard
Retrieve all dashboard instances.
get
Create dashboard instance.
post
Get dashboard instance by id.
get
Update dashboard instance.
patch
Delete dashboard instance with it's associated widgets
delete
Deviance
Get all deviances that has been created or resolved since an event
get
Get ad-object-deviance-history instance by id.
get
Get all ad objects of a deviance in CSV rows format
get
Get all deviances for a directory.
get
Get ad-object-deviance-history instance by id.
get
Update ad-object-deviance-history instance.
patch
Get all deviances related to a single directory and checker.
get
Update instances matching a checkerId.
patch
Get all deviances by checker.
post
Update the deviances emitted on a specific AD object and for a specific checker.
patch
Search all deviances by profile by checker by AD object
post
Get all deviances by eventId.
post
Directory
Retrieve all directory instances.
get
Create directory instance.
post
Get directory instance by id.
get
Get all directories for a given infrastructure
get
Get directory instance by id.
get
Update directory instance.
patch
Delete directory instance.
delete
Email notifier
Retrieve all email-notifier instances.
get
Create email-notifier instance.
post
Get email-notifier instance by id.
get
Update email-notifier instance.
patch
Delete email-notifier instance.
delete
Send a test email notification by id
get
Send a test email notification
post
Event
Get event instance by id.
get
Get event instance by id.
get
Search events instances
post
Infrastructure
Retrieve all infrastructure instances.
get
Create infrastructure instance.
post
Get infrastructure instance by id.
get
Update infrastructure instance.
patch
Delete infrastructure instance.
delete
LDAP configuration
Get ldap-configuration singleton.
get
Update ldap-configuration singleton.
patch
License
Get license singleton.
get
Create new license singleton
post
Get product association in the License
get
Lockout policy
Get the lockout policy
get
Update the lockout policy
patch
Metrics
Collect Eridanis and SQL Server health metrics.
get
Preference
Get a user's preferences
get
Update a user's preferences
patch
Profile
Retrieve all profile instances.
get
Create profile instance.
post
Get profile instance by id.
get
Update profile instance.
patch
Delete profile instance.
delete
Creates a new profile from another one
post
Unstages change of the related profile
post
Commits change of the related profile
post
Reason
Retrieve all reason instances.
get
Get reason instance by id.
get
Retrieve all reason instances that have deviances for a specific profile and checker.
get
Retrieve all reason instances for which we have deviances for a specific profile, directory and event.
get
Relay
Get current linking key for relay setup
get
Report access token
Returns the authentication token required to pull data from Tenable Cloud
get
Updates the authentication token required to pull data from Tenable Cloud
post
Role
Retrieve all role instances.
get
Create role instance.
post
Return the default roles for user creation
get
Get role instance by id.
get
Update role instance.
patch
Delete role instance.
delete
Creates a new role from another one
post
Replace permission list for a role
put
SAML configuration
Get saml-configuration singleton.
get
Update saml-configuration singleton.
patch
Generates SAML certificate
get
Score
Get the directories score by profile
get
Syslog
Retrieve all syslog instances.
get
Create syslog instance.
post
Get syslog instance by id.
get
Update syslog instance.
patch
Delete syslog instance.
delete
Send a test syslog notification by id
get
Send a test syslog notification
post
Topology
Get a representation of the AD topology.
get
User
Get all users
get
Create user instance.
post
Get a user's information
get
Get user instance by id.
get
Update user instance.
patch
Delete user instance.
delete
Update a user's password
patch
Logs in a user
post
Logs out a user
post
Replace role list for a user
put
Widget
Get all widgets by dashboard id
get
Create a new widget in dashboard by dashboard id
post
Get widget instance by id.
get
Update widget instance.
patch
Delete widget instance.
delete
Get a widget's options by id
get
Define widget's options by id
put
Attack Surface Management
Tags
Get tags from store
get
Add a new tag to the store
post
Delete tag from store
post
Edit tag by id
post
Search tags by name
post
Add all assets to all tags
post
Remove all assets from all tags
post
Add all assets to all tags using a filter
post
Remove all assets from all tags using a filter
post
Sources
List of Sources
get
Add source to inventory
post
Add an IP source to inventory
post
Add source to inventory
post
Add source to inventory
post
Add an Azure based source to the inventory
post
Add an ASN source to inventory
post
Add multiple IP sources
post
Add multiple cloudflare sources from all the zones that the given API key has access to.
post
Get the source by id
post
Delete the source by id
post
Add multiple sources
post
Delete multiple sources
post
Assets
List assets
post
Get asset details
get
Get asset history
get
List archived asset results
post
Get the severity breakdown for the specified asset
get
Assets Bulk Operations
Move or copy specific assets
post
Move or copy filtered assets
post
Archive or unarchive assets
post
Archive or unarchive filtered assets
post
Alerts
Get subscription alerts
get
Dashboard
Access aggregate data
post
Subscriptions
Get subscriptions from store
get
Get subscription from store by ID
get
Get assets recently added to smartfolder specified by ID
get
Get the subscription history by ID
get
Add a new subscription to the store
post
Edit subscription by id
post
Remove a subscription from the store
post
Text Records
/txt-records/search
post
Global
List asset properties.
get
Logs
Get user action logs from store.
post
Cloudflare Keys
Create Cloudflare key
post
List Cloudflare keys
get
Update Cloudflare key
post
Delete Cloudflare key
delete
List zones
get
Aws Keys
Create AWS key
post
List AWS keys
get
Update Azure key
post
Delete AWS key
delete
Azure Keys
Create Azure key
post
List Azure keys
get
Update Azure key
post
Delete Azure key
delete
Export
Download export
post
Export assets in XLSX format
post
Export assets in CSV format
post
Export assets in JSON format
post
Export source list in CSV format
post
Export source list in XLSX format
post
Inventory
Get the asset limit of the current inventory
get
List the assets in your Inventory
post
Edit current inventory name and description.
patch
Create a new inventory
post
Get user inventories
get
Leave the given inventory.
post
Suggestions
Get current inventory suggestions list
post
Count all suggestions of inventory with filters applied
post
Accept suggestions
post
Decline suggestions
post
Get all users
get
{protocol}://customer.tenable.ad/api/users
Required license type: none
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https
://customer.tenable.ad
/api/users
RESPONSE
Click
Try It!
to start a request and see the response here!