/config
Methods
GET
Gets the system configuration types
Request Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : [
{
"id" : 1,
"name" : "Commands"
},
{
"id" : 2,
"name" : "Active Plugins"
},
{
"id" : 4,
"name" : "Passive Plugins"
},
{
"id" : 8,
"name" : "SMTP"
},
{
"id" : 32,
"name" : "Scanner"
},
{
"id" : 64,
"name" : "Application"
},
{
"id" : 128,
"name" : "Expiration"
},
{
"id" : 256,
"name" : "Web Proxy"
},
{
"id" : 512,
"name" : "Status"
},
{
"id" : 1024,
"name" : "Logging"
},
{
"id" : 2048,
"name" : "Advanced"
},
{
"id" : 4096,
"name" : "Cosign"
},
{
"id" : 8192,
"name" : "Reporting"
},
{
"id" : 16384,
"name" : "Feed"
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410207176
}
/config/{id}
Methods
GET
Gets the configuration information associated with configuration type {id}.
Request Query Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : {
"id" : "1",
"name" : "Active Plugins",
"CommandTAR" : "\/bin\/tar",
"CommandRM" : "\/bin\/rm",
"CommandGUNZIP" : "\/bin\/gunzip",
"CommandZIP" : "\/usr\/bin\/zip",
"CommandFILE" : "\/usr\/bin\/file",
"CommandUNZIP" : "\/usr\/bin\/unzip",
"CommandZCAT" : "\/bin\/zcat",
"CommandGZIP" : "\/bin\/gzip"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410207242
}
PATCH
Edits the configuration information associated with configuration type {id}, changing only the passed in fields.
Request Parameters
(All fields are optional)
ExpandNOTE #1: For types "ScanResultExpiration" | "reportResultExpiration" | TicketExpiration" | "VulnTrendExpiration", Configuration value field must contain a positive integer (0 or greater)
NOTE #2: For valid names for types, perform config/{id}::GET on desired configuration type.
{
<name:string> : <value:string>...
}
Example Response
Expand{
"type" : "regular",
"response" : {
"id" : "1",
"name" : {
"id" : 2,
"name" : "Active Plugins"
},
"CommandTAR" : "\/bin\/tar2",
"CommandRM" : "\/bin\/rm",
"CommandGUNZIP" : "\/bin\/gunzip",
"CommandZIP" : "\/usr\/bin\/zip",
"CommandFILE" : "\/usr\/bin\/file",
"CommandUNZIP" : "\/usr\/bin\/unzip",
"CommandZCAT" : "\/bin\/zcat",
"CommandGZIP" : "\/bin\/gzip"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410209192
}
/config/query
Methods
GET
Gets the status of the configuration type(s) specified
Request Parameters
ExpandParameters must be passed in as query string (as opposed to JSON) in the format of: /config/query?item=smtp
{
"item" : <string> (comma-separated array) "smtp" &| "reportTypes" &| "mdmTypes" &| "complianceTypes" &| "ldap" &| "saml"
}
Example Response
Expand{
"type" : "regular",
"response" :
[
{
"item" : "ldap",
"configured" : false
},
{
"item" : "saml",
"configured" : false
},
{
"item" : "smtp",
"configured" : false
},
{
"item":"reportTypes",
"details":[
{
"name":"PDF",
"type":"pdf",
"enabled":"true",
"attributeSets":[]
},
{
"name":"CSV",
"type":"csv",
"enabled":"true",
"attributeSets":[]
},
{
"name":"RTF",
"type":"rtf",
"enabled":"true",
"attributeSets":[]
},
{
"name":"DISA ARF",
"type":"arf",
"enabled":"false",
"attributeSets":[
"arf"
]
},
{
"name":"DISA ASR",
"type":"asr",
"enabled":"false",
"attributeSets":[]
},
{
"name":"CyberScope",
"type":"lasr",
"enabled":"false",
"attributeSets":[
"lasr"
]
}
]
},
{
"item" : "mdmTypes",
"details" : [
{
"id" : "1",
"name" : "ActiveSync",
"description" : "",
"value" : "ActiveSync",
"ipPref" : "Domain Controller : ",
"pluginIDs" : [
{
"id" : "60024"
}
],
"editor" : "W3sidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiAiRG9tYWluIENvbnRyb2xsZXIiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6ICJkb21haW5fY29udHJvbGxlciJ9LCB7InR5cGUiOiAiZW50cnkiLCJuYW1lIjogIkRvbWFpbiIsInJlcXVpcmVkIjoidHJ1ZSIsImlkIjogImRvbWFpbiJ9LHsidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiAiRG9tYWluIFVzZXJuYW1lIiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiAiZG9tYWluX2FkbWluIn0seyJ0eXBlIjogInBhc3N3b3JkIiwibmFtZSI6ICJEb21haW4gUGFzc3dvcmQiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6ICJwYXNzd29yZCJ9XQ=="
},
{
"id" : "2",
"name" : "Apple Profile Manager",
"description" : "",
"value" : "profile_manager",
"ipPref" : "Apple Profile Manager server : ",
"pluginIDs" : [
{
"id" : "60032"
}
],
"editor" : "W3sidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiJTZXJ2ZXIiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InNlcnZlciJ9LCB7InR5cGUiOiAiZW50cnkiLCJuYW1lIjoiUG9ydCIsImRlZmF1bHQiOjQ0MywicmVnZXgiOiAiXihbMC05XXsxLDR9fFsxLTVdWzAtOV17NH18NlswLTRdWzAtOV17M318NjVbMC00XVswLTldezJ9fDY1NVswLTJdWzAtOV18NjU1M1swLTVdKSQiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InBvcnQifSx7InR5cGUiOiAiZW50cnkiLCJuYW1lIjoiVXNlcm5hbWUiLCJyZXF1aXJlZCI6dHJ1ZSwiaWQiOiJ1c2VybmFtZSJ9LHsidHlwZSI6ICJwYXNzd29yZCIsIm5hbWUiOiJQYXNzd29yZCIsInJlcXVpcmVkIjp0cnVlLCJpZCI6InBhc3N3b3JkIn0seyJ0eXBlIjogImNoZWNrYm94IiwibmFtZSI6ICJIVFRQUyIsImlkIjogImh0dHBzIiwiZGVmYXVsdCI6ICJ5ZXMiLCJjb25kaXRpb25hbFNldHRpbmdzIjogeyJ5ZXMiOiB7ImlucHV0cyI6IFt7InR5cGUiOiAiY2hlY2tib3giLCJuYW1lIjogIlZlcmlmeSBTU0wgQ2VydGlmaWNhdGUiLCJyZXF1aXJlZCI6ICJ0cnVlIiwiZGVmYXVsdCI6ICJ5ZXMiLCJpZCI6ICJ2ZXJpZnlfc3NsIn1dfX19XQ=="
},
{
"id" : "3",
"name" : "Good MDM",
"description" : "",
"value" : "GoodMDM",
"ipPref" : "GMC Server : ",
"pluginIDs" : [
{
"id" : "66963"
}
],
"editor" : "W3sidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiJTZXJ2ZXIiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InNlcnZlciJ9LCB7InR5cGUiOiAiZW50cnkiLCJuYW1lIjoiUG9ydCIsInJlZ2V4IjogIl4oWzAtOV17MSw0fXxbMS01XVswLTldezR9fDZbMC00XVswLTldezN9fDY1WzAtNF1bMC05XXsyfXw2NTVbMC0yXVswLTldfDY1NTNbMC01XSkkIiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiJwb3J0In0seyJ0eXBlIjogImVudHJ5IiwibmFtZSI6IkRvbWFpbiIsInJlcXVpcmVkIjoidHJ1ZSIsImlkIjoiZG9tYWluIn0seyJ0eXBlIjogImVudHJ5IiwibmFtZSI6IlVzZXJuYW1lIiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiJ1c2VybmFtZSJ9LHsidHlwZSI6ICJwYXNzd29yZCIsIm5hbWUiOiJQYXNzd29yZCIsInJlcXVpcmVkIjoidHJ1ZSIsImlkIjoicGFzc3dvcmQifSx7InR5cGUiOiAiY2hlY2tib3giLCJuYW1lIjogIkhUVFBTIiwiaWQiOiAiaHR0cHMiLCJkZWZhdWx0IjogInllcyIsImNvbmRpdGlvbmFsU2V0dGluZ3MiOiB7InllcyI6IHsiaW5wdXRzIjogW3sidHlwZSI6ICJjaGVja2JveCIsIm5hbWUiOiAiVmVyaWZ5IFNTTCBDZXJ0aWZpY2F0ZSIsInJlcXVpcmVkIjogInRydWUiLCJkZWZhdWx0IjogInllcyIsImlkIjogInZlcmlmeV9zc2wifV19fX1d"
},
{
"id" : "4",
"name" : "Mobile Iron",
"description" : "",
"value" : "MobileIron",
"ipPref" : "MobileIron VSP Admin Portal URL : ",
"pluginIDs" : [
{
"id" : "72904"
}
],
"editor" : "W3sidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiJNb2JpbGVJcm9uIFZTUCBBZG1pbiBQb3J0YWwgVVJMIiwicmVxdWlyZWQiOiJ0cnVlIiwicGxhY2Vob2xkZXIiOiJodHRwczovL3d3dy5leGFtcGxlLm5ldC9taWZzL2xvZ2luLmpzcCIsImlkIjoicG9ydGFsX3VybCJ9LCB7InR5cGUiOiAiZW50cnkiLCJuYW1lIjoiTW9iaWxlSXJvbiBQb3J0IiwicmVnZXgiOiAiXihbMC05XXsxLDR9fFsxLTVdWzAtOV17NH18NlswLTRdWzAtOV17M318NjVbMC00XVswLTldezJ9fDY1NVswLTJdWzAtOV18NjU1M1swLTVdKSQiLCJyZXF1aXJlZCI6InRydWUiLCJkZWZhdWx0IjoiNDQzIiwiaWQiOiJwb3J0In0seyJ0eXBlIjogImVudHJ5IiwibmFtZSI6IlVzZXJuYW1lIiwicmVxdWlyZWQiOnRydWUsInBsYWNlaG9sZGVyIjoiYXBpdXNlciIsImlkIjoidXNlcm5hbWUifSx7InR5cGUiOiAicGFzc3dvcmQiLCJuYW1lIjoiUGFzc3dvcmQiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InBhc3N3b3JkIn0seyJ0eXBlIjogImNoZWNrYm94IiwibmFtZSI6ICJIVFRQUyIsImlkIjogImh0dHBzIiwiZGVmYXVsdCI6ICJ5ZXMiLCJjb25kaXRpb25hbFNldHRpbmdzIjogeyJ5ZXMiOiB7ImlucHV0cyI6IFt7InR5cGUiOiAiY2hlY2tib3giLCJuYW1lIjogIlZlcmlmeSBTU0wgQ2VydGlmaWNhdGUiLCJyZXF1aXJlZCI6ICJ0cnVlIiwiZGVmYXVsdCI6ICJ5ZXMiLCJpZCI6ICJ2ZXJpZnlfc3NsIn1dfX19XQ=="
},
{
"id" : "5",
"name" : "AirWatch MDM",
"description" : "",
"value" : "AirWatch",
"ipPref" : "AirWatch Environment API URL : ",
"pluginIDs" : [
{
"id" : "76460"
}
],
"editor" : "W3sidHlwZSI6ICJlbnRyeSIsIm5hbWUiOiAiQWlyV2F0Y2ggRW52aXJvbm1lbnQgQVBJIFVSTCIsInBsYWNlaG9sZGVyIjoiaHR0cHM6Ly9haXJ3YXRjaC5leGFtcGxlLm5ldC9haXJ3YXRjaHNlcnZpY2VzLzAvIiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiAiYXBpX3VybCJ9LCB7InR5cGUiOiAiZW50cnkiLCJuYW1lIjogIlBvcnQiLCJkZWZhdWx0IjoiNDQzIiwicmVnZXgiOiAiXihbMC05XXsxLDR9fFsxLTVdWzAtOV17NH18NlswLTRdWzAtOV17M318NjVbMC00XVswLTldezJ9fDY1NVswLTJdWzAtOV18NjU1M1swLTVdKSQiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InBvcnQifSx7InR5cGUiOiAiZW50cnkiLCJuYW1lIjogIlVzZXJuYW1lIiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiJ1c2VybmFtZSJ9LHsidHlwZSI6ICJwYXNzd29yZCIsIm5hbWUiOiAiUGFzc3dvcmQiLCJyZXF1aXJlZCI6InRydWUiLCJpZCI6InBhc3N3b3JkIn0seyJ0eXBlIjogImVudHJ5IiwibmFtZSI6ICJBUEkgS2V5IiwicmVxdWlyZWQiOiJ0cnVlIiwiaWQiOiJhcGlfa2V5In0seyJ0eXBlIjogImNoZWNrYm94IiwibmFtZSI6ICJIVFRQUyIsImlkIjogImh0dHBzIiwiZGVmYXVsdCI6ICJ5ZXMiLCJjb25kaXRpb25hbFNldHRpbmdzIjogeyJ5ZXMiOiB7ImlucHV0cyI6IFt7InR5cGUiOiAiY2hlY2tib3giLCJuYW1lIjogIlZlcmlmeSBTU0wgQ2VydGlmaWNhdGUiLCJyZXF1aXJlZCI6ICJ0cnVlIiwiZGVmYXVsdCI6ICJ5ZXMiLCJpZCI6ICJ2ZXJpZnlfc3NsIn1dfX19XQ=="
}
]
},
{
"item":"complianceTypes",
"details":{
"windows":{
"pluginID":"21156",
"auditFileType":"windows",
"displayName":"Windows"
},
"unix":{
"pluginID":"21157",
"auditFileType":"unix",
"displayName":"Unix"
},
"windowsfiles":{
"pluginID":"24760",
"auditFileType":"windowsfiles",
"displayName":"Windows Files"
},
"database":{
"pluginID":"33814",
"auditFileType":"database",
"displayName":"Database"
},
"cisco":{
"pluginID":"46689",
"auditFileType":"cisco",
"displayName":"Cisco"
},
"as\/400":{
"pluginID":"57860",
"auditFileType":"as\/400",
"displayName":"AS\/400"
},
"checkpoint":{
"pluginID":"62679",
"auditFileType":"checkpoint",
"displayName":"Checkpoint"
},
"juniper":{
"pluginID":"62680",
"auditFileType":"juniper",
"displayName":"Juniper"
},
"palo_alto":{
"pluginID":"64095",
"auditFileType":"palo_alto",
"displayName":"Palo Alto"
},
"vmware":{
"pluginID":"64455",
"auditFileType":"vmware",
"displayName":"VMWare"
},
"scapWindows":{
"pluginID":"66756",
"auditFileType":"scapWindows",
"displayName":"SCAP Windows"
},
"scapLinux":{
"pluginID":"66757",
"auditFileType":"scapLinux",
"displayName":"SCAP Linux"
},
"netapp":{
"pluginID":"66934",
"auditFileType":"netapp",
"displayName":"NetApp"
},
"xenserver":{
"pluginID":"69512",
"auditFileType":"xenserver",
"displayName":"Citrix XenServer"
},
"hpprocurve":{
"pluginID":"70271",
"auditFileType":"hpprocurve",
"displayName":"HP ProCurve"
},
"fortigate":{
"pluginID":"70272",
"auditFileType":"fortigate",
"displayName":"Fortigate FortiOS"
},
"fireeye":{
"pluginID":"70469",
"auditFileType":"fireeye",
"displayName":"FireEye"
},
"brocade":{
"pluginID":"71842",
"auditFileType":"brocade",
"displayName":"Brocade FabricOS"
},
"sonicwall":{
"pluginID":"71955",
"auditFileType":"sonicwall",
"displayName":"SonicWALL SonicOS"
},
"adtran":{
"pluginID":"71991",
"auditFileType":"adtran",
"displayName":"Adtran AOS"
},
"amazon_aws":{
"pluginID":"72426",
"auditFileType":"amazon_aws",
"displayName":"Amazon AWS"
},
"extreme_extremexos":{
"pluginID":"73156",
"auditFileType":"extreme_extremexos",
"displayName":"Extreme ExtremeXOS"
}
}
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410209808
}
/config/testSMTP
Methods
POST
Tests the SMTP settings
Request Parameters
Expand{
"SMTPPassword" : <string> OPTIONAL
}
Example Response
Expand{
"type" : "regular",
"response" : {
"status" : false,
"message" : "Sender not accepted."
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410210283
}
/config/license/register
/tes/config/license/register
/tes/config/license/register is only available in Tenable Enclave Security
Methods
POST
Registers a license file
Request Parameters
Expand{
"filename" : <string> (name of uploaded file)
}
Example Response
Expand{
"type" : "regular",
"response" : {
"config" : {
"Version" : "5.0.0",
"Banner" : "",
"Logo" : "assets\/mariana\/images\/sc4icon.png",
"LoginSessionTimeout" : "3600",
"LoginMaxAttempts" : "20",
"URL" : "https:\/\/192.168.1.1\/",
"VulnTrendExpiration" : "90",
"FreshInstall" : "no",
"ScanResultExpiration" : "365",
"ReportResultExpiration" : "365",
"TicketExpiration" : "365",
"AdvancedFields" : "MaxNessusChunkSize,ScannerStatusConnectTimeout,ScannerStatusTimeout",
"LicenseConfig" : {
"ipCount" : "0",
"mode" : "SC",
"timestamp" : 1410149400,
"features" : {
"" : ""
},
"status" : "Valid",
"maxIPCount" : "500000",
"expiration" : 1410926400,
"hostname" : "name",
"customer" : "Customer",
"type" : "Demo"
},
"HeaderText" : "",
"PluginUpdateSiteACAS" : "",
"PasswordMinLength" : "3",
"ServerAuth" : "any",
"MaxNessusChunkSize" : "-1",
"ServerClassification" : "None",
"SupportV1Data" : "true",
"LCEPluginUpdateSiteACAS" : "",
"FeedActivationCode" : "",
"FeedSubscriptionStatus" : "Expired",
"FeedUpdateSite" : "downloads.nessus.org",
"FeedPackage" : "SecurityCenterFeed48.tar.gz",
"FeedUpdateSiteACAS" : "",
"SecurityCenterID" : "192.168.1.1",
"SecurityCenterIDOverride" : "",
"EnabledReports" : "pdf,rtf,csv,lasr"
},
"reportTypes" : [
{
"name" : "PDF",
"type" : "pdf",
"enabled" : "true",
"attributeSets" : []
},
{
"name" : "CSV",
"type" : "csv",
"enabled" : "true",
"attributeSets" : []
},
{
"name" : "RTF",
"type" : "rtf",
"enabled" : "true",
"attributeSets" : []
},
{
"name" : "DISA ARF",
"type" : "arf",
"enabled" : "false",
"attributeSets" : ["arf"]
},
{
"name" : "DISA ASR",
"type" : "asr",
"enabled" : "false",
"attributeSets" : []
},
{
"name" : "CyberScope",
"type" : "lasr",
"enabled" : "true",
"attributeSets" : ["lasr"]
}
],
"licenseStatus" : "Valid",
"mode" : "SC",
"ACAS" : "false"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410210722
}
/config/plugins/register
Methods
POST
Registers the plugin specified
Request Parameters
Expand{
"activationCode" : <string>,
"updateSite" : <string>,
"type" : <string> "active" | "lce" | "passive" | "industrial"
}
Example Response
Expand{
"type" : "regular",
"response" : {
"PluginSubscriptionStatus" : "Invalid"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410211133
}
/config/plugins/reset
Methods
POST
Resets the plugin codes for the plugin type parameter specified
Request Parameters
Expand{
"type" : <string> "active" | "lce" | "passive" | "industrial"
}
Example Response
Expand{
"type" : "regular",
"response" : {
"PluginSubscriptionStatus" : "Unconfigured"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1410211133
}