/system
Methods
Gets the system initialization information.
NOTE #1: This should only be called prior to login.
NOTE #2: SAML/Card/certificate users will automatically receive a token attribute included in the response element or an error response indicating an authentication failure, provided their card is inserted. The token attribute corresponds to the same element received in from /token::POST call.
NOTE #3: SAML users will automatically receive a token attribute included in the response element or an error response indicating an authentication failure. The token attribute corresponds to the same element received in from /token::POST call.
NOTE #4:theversion
,nbsp;activeIPs
,nbsp;licensedIPs
andlicenseExpiration
fields in the response will only show if you make this API call authenticated. Additionally, if the license is "perpetual" then the licenseExpiration
field is returned as "never" instead of a timestamp.
Note #5: postgresConnStatus, postgresConnectionType, postgresDsn, VulnerabilityIntelligenceEnabled will only be shown to logged in users. Additionally, postgresDsn field will be shown only when the postgresConnectionType is "external"
Request Parameters
None
Example Response
/system/debug
/tes/system/debug
Methods
Gets the list of debug items.
Request Query Parameters
None
Example Response
Edits one or more debug items. Only the debug items specified are modified.
Request Parameters
Example Response
See /system/debug::GET/system/diagnostics
The /system/diagnostics resource.
Methods
Gets the system diagnostics information.
Fields Parameter
Request Parameters
None
Example Response
/system/diagnostics/generate
The /system/diagnostics/generate resource.
Methods
Starts an on-demand, diagnostics analysis for the System that can be downloaded after its job completes.
Request Parameters
Example Response
/system/diagnostics/download
The /system/diagnostics/download resource.
Methods
Downloads the system diagnostics, debug file that was last generated.
NOTE:The /system/diagnostics/generate command should be used to generate a diagnostics file of the System for download.
Request Parameters
None
Example Response
None given. The response will be a zipped or gzipped file containing the System's diagnostics information.
/system/debuglogs/generate
The /system/debuglogs/generate resource.
Methods
Starts an on-demand request to generate a debugging logs archive based on a given timeframe that can be downloaded after its job completes.
Request Parameters
Example Response
/system/debuglogs/download
The /system/debuglogs/download resource.
Methods
Downloads the last generated debugging logs archive.
NOTE: The /system/debuglogs/generate command should be used to generate a debugging logs archive for download.
Request Parameters
None
Example Response
None given. The response will be a zipped file containing debugging logs.
/system/locale
Methods
Change the Locale to the one selected by the admin
NOTE: Only available languages can be used. See available Locales by calling /system/locales::GET (see below). An empty string resets to the default locale (English).
Request Parameters
Example Response
/system/locales
Methods
/system/logFiles
Methods
Gets the list of log files available to the user
Request Parameters
None
Example Response for Admins
Example Response for Security Managers
/system/logs
Methods
Returns the available log messages based on user permissions and the query filters
Request Parameters
Example Response
/system/logs/download
Methods
Downloads log messages that are available to the user based on the query parameter.
NOTE: The system logs are downloaded as a CSV file.
Request Parameters
Example Response
/system/logs/modules
Methods
Get a full list of all modules which output to the System Log.
Request Parameters
Example Response
/system/fips
Methods
Set the status of FIPS in Tenable.sc.
NOTE #1: Tenable.sc will need to be restarted for this to take affect.