/system
Methods
GET
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: the version, activeIPs, licensedIPs and licenseExpiration 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
Expand{
"type" : "regular",
"response" : {
"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"
]
}
],
"version" : "5.12.0",
"activeIPs: : 1,
"licensedIPs": 1024,
"licenseExpiration": 1661817600,
"buildID" : "201905293482",
"banner" : "",
"releaseID" : "201905293482",
"riskRuleCommentsEnabled" : "true",
"uuid" : "12345678-9101-2345-6789-012345678901",
"uuidsha256" : "9bbc05d3e24c93888b8f271fc653300b68cef4aaa62a44a14835a5cd07397b5c"
"logo" : "assets/mariana/images/sc4icon.png",
"serverAuth" : "any",
"serverClassification" : "None",
"sessionTimeout" : "3600",
"licenseStatus" : "Valid",
"ACAS" : "false",
"freshInstall" : "no",
"headerText" : "",
"loginNotifications" : "false",
"PasswordComplexity" : "false",
"telemetryEnabled" : "true",
"SAML" : "false",
"SerializationDisabled" : "true",
"timezones" : [
{
"name" : "Africa/Abidjan",
"gmtOffset" : 0
},
{
"name" : "Africa/Accra",
"gmtOffset" : 0
},
{
"name" : "Africa/Addis_Ababa",
"gmtOffset" : 3
},
{
"name" : "Africa/Algiers",
"gmtOffset" : 1
},
{
"name" : "Africa/Asmara",
"gmtOffset" : 3
},
{
"name" : "Africa/Bamako",
"gmtOffset" : 0
},
{
"name" : "Africa/Bangui",
"gmtOffset" : 1
},
{
"name" : "Africa/Banjul",
"gmtOffset" : 0
},
{
"name" : "Africa/Bissau",
"gmtOffset" : 0
},
{
"name" : "Africa/Blantyre",
"gmtOffset" : 2
},
{
"name" : "Africa/Brazzaville",
"gmtOffset" : 1
},
{
"name" : "Africa/Bujumbura",
"gmtOffset" : 2
},
{
"name" : "Africa/Cairo",
"gmtOffset" : 2
},
{
"name" : "Africa/Casablanca",
"gmtOffset" : 1
},
{
"name" : "Africa/Ceuta",
"gmtOffset" : 2
},
{
"name" : "Africa/Conakry",
"gmtOffset" : 0
},
{
"name" : "Africa/Dakar",
"gmtOffset" : 0
},
{
"name" : "Africa/Dar_es_Salaam",
"gmtOffset" : 3
},
{
"name" : "Africa/Djibouti",
"gmtOffset" : 3
},
{
"name" : "Africa/Douala",
"gmtOffset" : 1
},
{
"name" : "Africa/El_Aaiun",
"gmtOffset" : 1
},
{
"name" : "Africa/Freetown",
"gmtOffset" : 0
},
{
"name" : "Africa/Gaborone",
"gmtOffset" : 2
},
{
"name" : "Africa/Harare",
"gmtOffset" : 2
},
{
"name" : "Africa/Johannesburg",
"gmtOffset" : 2
},
{
"name" : "Africa/Juba",
"gmtOffset" : 3
},
{
"name" : "Africa/Kampala",
"gmtOffset" : 3
},
{
"name" : "Africa/Khartoum",
"gmtOffset" : 2
},
{
"name" : "Africa/Kigali",
"gmtOffset" : 2
},
{
"name" : "Africa/Kinshasa",
"gmtOffset" : 1
},
{
"name" : "Africa/Lagos",
"gmtOffset" : 1
},
{
"name" : "Africa/Libreville",
"gmtOffset" : 1
},
{
"name" : "Africa/Lome",
"gmtOffset" : 0
},
{
"name" : "Africa/Luanda",
"gmtOffset" : 1
},
{
"name" : "Africa/Lubumbashi",
"gmtOffset" : 2
},
{
"name" : "Africa/Lusaka",
"gmtOffset" : 2
},
{
"name" : "Africa/Malabo",
"gmtOffset" : 1
},
{
"name" : "Africa/Maputo",
"gmtOffset" : 2
},
{
"name" : "Africa/Maseru",
"gmtOffset" : 2
},
{
"name" : "Africa/Mbabane",
"gmtOffset" : 2
},
{
"name" : "Africa/Mogadishu",
"gmtOffset" : 3
},
{
"name" : "Africa/Monrovia",
"gmtOffset" : 0
},
{
"name" : "Africa/Nairobi",
"gmtOffset" : 3
},
{
"name" : "Africa/Ndjamena",
"gmtOffset" : 1
},
{
"name" : "Africa/Niamey",
"gmtOffset" : 1
},
{
"name" : "Africa/Nouakchott",
"gmtOffset" : 0
},
{
"name" : "Africa/Ouagadougou",
"gmtOffset" : 0
},
{
"name" : "Africa/Porto-Novo",
"gmtOffset" : 1
},
{
"name" : "Africa/Sao_Tome",
"gmtOffset" : 1
},
{
"name" : "Africa/Tripoli",
"gmtOffset" : 2
},
{
"name" : "Africa/Tunis",
"gmtOffset" : 1
},
{
"name" : "Africa/Windhoek",
"gmtOffset" : 2
},
{
"name" : "America/Adak",
"gmtOffset" : -9
},
{
"name" : "America/Anchorage",
"gmtOffset" : -8
},
{
"name" : "America/Anguilla",
"gmtOffset" : -4
},
{
"name" : "America/Antigua",
"gmtOffset" : -4
},
{
"name" : "America/Araguaina",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Buenos_Aires",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Catamarca",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Cordoba",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Jujuy",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/La_Rioja",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Mendoza",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Rio_Gallegos",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Salta",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/San_Juan",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/San_Luis",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Tucuman",
"gmtOffset" : -3
},
{
"name" : "America/Argentina/Ushuaia",
"gmtOffset" : -3
},
{
"name" : "America/Aruba",
"gmtOffset" : -4
},
{
"name" : "America/Asuncion",
"gmtOffset" : -4
},
{
"name" : "America/Atikokan",
"gmtOffset" : -5
},
{
"name" : "America/Bahia",
"gmtOffset" : -3
},
{
"name" : "America/Bahia_Banderas",
"gmtOffset" : -5
},
{
"name" : "America/Barbados",
"gmtOffset" : -4
},
{
"name" : "America/Belem",
"gmtOffset" : -3
},
{
"name" : "America/Belize",
"gmtOffset" : -6
},
{
"name" : "America/Blanc-Sablon",
"gmtOffset" : -4
},
{
"name" : "America/Boa_Vista",
"gmtOffset" : -4
},
{
"name" : "America/Bogota",
"gmtOffset" : -5
},
{
"name" : "America/Boise",
"gmtOffset" : -6
},
{
"name" : "America/Cambridge_Bay",
"gmtOffset" : -6
},
{
"name" : "America/Campo_Grande",
"gmtOffset" : -4
},
{
"name" : "America/Cancun",
"gmtOffset" : -5
},
{
"name" : "America/Caracas",
"gmtOffset" : -4
},
{
"name" : "America/Cayenne",
"gmtOffset" : -3
},
{
"name" : "America/Cayman",
"gmtOffset" : -5
},
{
"name" : "America/Chicago",
"gmtOffset" : -5
},
{
"name" : "America/Chihuahua",
"gmtOffset" : -6
},
{
"name" : "America/Costa_Rica",
"gmtOffset" : -6
},
{
"name" : "America/Creston",
"gmtOffset" : -7
},
{
"name" : "America/Cuiaba",
"gmtOffset" : -4
},
{
"name" : "America/Curacao",
"gmtOffset" : -4
},
{
"name" : "America/Danmarkshavn",
"gmtOffset" : 0
},
{
"name" : "America/Dawson",
"gmtOffset" : -7
},
{
"name" : "America/Dawson_Creek",
"gmtOffset" : -7
},
{
"name" : "America/Denver",
"gmtOffset" : -6
},
{
"name" : "America/Detroit",
"gmtOffset" : -4
},
{
"name" : "America/Dominica",
"gmtOffset" : -4
},
{
"name" : "America/Edmonton",
"gmtOffset" : -6
},
{
"name" : "America/Eirunepe",
"gmtOffset" : -5
},
{
"name" : "America/El_Salvador",
"gmtOffset" : -6
},
{
"name" : "America/Fort_Nelson",
"gmtOffset" : -7
},
{
"name" : "America/Fortaleza",
"gmtOffset" : -3
},
{
"name" : "America/Glace_Bay",
"gmtOffset" : -3
},
{
"name" : "America/Godthab",
"gmtOffset" : -2
},
{
"name" : "America/Goose_Bay",
"gmtOffset" : -3
},
{
"name" : "America/Grand_Turk",
"gmtOffset" : -4
},
{
"name" : "America/Grenada",
"gmtOffset" : -4
},
{
"name" : "America/Guadeloupe",
"gmtOffset" : -4
},
{
"name" : "America/Guatemala",
"gmtOffset" : -6
},
{
"name" : "America/Guayaquil",
"gmtOffset" : -5
},
{
"name" : "America/Guyana",
"gmtOffset" : -4
},
{
"name" : "America/Halifax",
"gmtOffset" : -3
},
{
"name" : "America/Havana",
"gmtOffset" : -4
},
{
"name" : "America/Hermosillo",
"gmtOffset" : -7
},
{
"name" : "America/Indiana/Indianapolis",
"gmtOffset" : -4
},
{
"name" : "America/Indiana/Knox",
"gmtOffset" : -5
},
{
"name" : "America/Indiana/Marengo",
"gmtOffset" : -4
},
{
"name" : "America/Indiana/Petersburg",
"gmtOffset" : -4
},
{
"name" : "America/Indiana/Tell_City",
"gmtOffset" : -5
},
{
"name" : "America/Indiana/Vevay",
"gmtOffset" : -4
},
{
"name" : "America/Indiana/Vincennes",
"gmtOffset" : -4
},
{
"name" : "America/Indiana/Winamac",
"gmtOffset" : -4
},
{
"name" : "America/Inuvik",
"gmtOffset" : -6
},
{
"name" : "America/Iqaluit",
"gmtOffset" : -4
},
{
"name" : "America/Jamaica",
"gmtOffset" : -5
},
{
"name" : "America/Juneau",
"gmtOffset" : -8
},
{
"name" : "America/Kentucky/Louisville",
"gmtOffset" : -4
},
{
"name" : "America/Kentucky/Monticello",
"gmtOffset" : -4
},
{
"name" : "America/Kralendijk",
"gmtOffset" : -4
},
{
"name" : "America/La_Paz",
"gmtOffset" : -4
},
{
"name" : "America/Lima",
"gmtOffset" : -5
},
{
"name" : "America/Los_Angeles",
"gmtOffset" : -7
},
{
"name" : "America/Lower_Princes",
"gmtOffset" : -4
},
{
"name" : "America/Maceio",
"gmtOffset" : -3
},
{
"name" : "America/Managua",
"gmtOffset" : -6
},
{
"name" : "America/Manaus",
"gmtOffset" : -4
},
{
"name" : "America/Marigot",
"gmtOffset" : -4
},
{
"name" : "America/Martinique",
"gmtOffset" : -4
},
{
"name" : "America/Matamoros",
"gmtOffset" : -5
},
{
"name" : "America/Mazatlan",
"gmtOffset" : -6
},
{
"name" : "America/Menominee",
"gmtOffset" : -5
},
{
"name" : "America/Merida",
"gmtOffset" : -5
},
{
"name" : "America/Metlakatla",
"gmtOffset" : -8
},
{
"name" : "America/Mexico_City",
"gmtOffset" : -5
},
{
"name" : "America/Miquelon",
"gmtOffset" : -2
},
{
"name" : "America/Moncton",
"gmtOffset" : -3
},
{
"name" : "America/Monterrey",
"gmtOffset" : -5
},
{
"name" : "America/Montevideo",
"gmtOffset" : -3
},
{
"name" : "America/Montserrat",
"gmtOffset" : -4
},
{
"name" : "America/Nassau",
"gmtOffset" : -4
},
{
"name" : "America/New_York",
"gmtOffset" : -4
},
{
"name" : "America/Nipigon",
"gmtOffset" : -4
},
{
"name" : "America/Nome",
"gmtOffset" : -8
},
{
"name" : "America/Noronha",
"gmtOffset" : -2
},
{
"name" : "America/North_Dakota/Beulah",
"gmtOffset" : -5
},
{
"name" : "America/North_Dakota/Center",
"gmtOffset" : -5
},
{
"name" : "America/North_Dakota/New_Salem",
"gmtOffset" : -5
},
{
"name" : "America/Ojinaga",
"gmtOffset" : -6
},
{
"name" : "America/Panama",
"gmtOffset" : -5
},
{
"name" : "America/Pangnirtung",
"gmtOffset" : -4
},
{
"name" : "America/Paramaribo",
"gmtOffset" : -3
},
{
"name" : "America/Phoenix",
"gmtOffset" : -7
},
{
"name" : "America/Port-au-Prince",
"gmtOffset" : -4
},
{
"name" : "America/Port_of_Spain",
"gmtOffset" : -4
},
{
"name" : "America/Porto_Velho",
"gmtOffset" : -4
},
{
"name" : "America/Puerto_Rico",
"gmtOffset" : -4
},
{
"name" : "America/Punta_Arenas",
"gmtOffset" : -3
},
{
"name" : "America/Rainy_River",
"gmtOffset" : -5
},
{
"name" : "America/Rankin_Inlet",
"gmtOffset" : -5
},
{
"name" : "America/Recife",
"gmtOffset" : -3
},
{
"name" : "America/Regina",
"gmtOffset" : -6
},
{
"name" : "America/Resolute",
"gmtOffset" : -5
},
{
"name" : "America/Rio_Branco",
"gmtOffset" : -5
},
{
"name" : "America/Santarem",
"gmtOffset" : -3
},
{
"name" : "America/Santiago",
"gmtOffset" : -4
},
{
"name" : "America/Santo_Domingo",
"gmtOffset" : -4
},
{
"name" : "America/Sao_Paulo",
"gmtOffset" : -3
},
{
"name" : "America/Scoresbysund",
"gmtOffset" : 0
},
{
"name" : "America/Sitka",
"gmtOffset" : -8
},
{
"name" : "America/St_Barthelemy",
"gmtOffset" : -4
},
{
"name" : "America/St_Johns",
"gmtOffset" : -2.5
},
{
"name" : "America/St_Kitts",
"gmtOffset" : -4
},
{
"name" : "America/St_Lucia",
"gmtOffset" : -4
},
{
"name" : "America/St_Thomas",
"gmtOffset" : -4
},
{
"name" : "America/St_Vincent",
"gmtOffset" : -4
},
{
"name" : "America/Swift_Current",
"gmtOffset" : -6
},
{
"name" : "America/Tegucigalpa",
"gmtOffset" : -6
},
{
"name" : "America/Thule",
"gmtOffset" : -3
},
{
"name" : "America/Thunder_Bay",
"gmtOffset" : -4
},
{
"name" : "America/Tijuana",
"gmtOffset" : -7
},
{
"name" : "America/Toronto",
"gmtOffset" : -4
},
{
"name" : "America/Tortola",
"gmtOffset" : -4
},
{
"name" : "America/Vancouver",
"gmtOffset" : -7
},
{
"name" : "America/Whitehorse",
"gmtOffset" : -7
},
{
"name" : "America/Winnipeg",
"gmtOffset" : -5
},
{
"name" : "America/Yakutat",
"gmtOffset" : -8
},
{
"name" : "America/Yellowknife",
"gmtOffset" : -6
},
{
"name" : "Antarctica/Casey",
"gmtOffset" : 8
},
{
"name" : "Antarctica/Davis",
"gmtOffset" : 7
},
{
"name" : "Antarctica/DumontDUrville",
"gmtOffset" : 10
},
{
"name" : "Antarctica/Macquarie",
"gmtOffset" : 11
},
{
"name" : "Antarctica/Mawson",
"gmtOffset" : 5
},
{
"name" : "Antarctica/McMurdo",
"gmtOffset" : 12
},
{
"name" : "Antarctica/Palmer",
"gmtOffset" : -3
},
{
"name" : "Antarctica/Rothera",
"gmtOffset" : -3
},
{
"name" : "Antarctica/Syowa",
"gmtOffset" : 3
},
{
"name" : "Antarctica/Troll",
"gmtOffset" : 2
},
{
"name" : "Antarctica/Vostok",
"gmtOffset" : 6
},
{
"name" : "Arctic/Longyearbyen",
"gmtOffset" : 2
},
{
"name" : "Asia/Aden",
"gmtOffset" : 3
},
{
"name" : "Asia/Almaty",
"gmtOffset" : 6
},
{
"name" : "Asia/Amman",
"gmtOffset" : 3
},
{
"name" : "Asia/Anadyr",
"gmtOffset" : 12
},
{
"name" : "Asia/Aqtau",
"gmtOffset" : 5
},
{
"name" : "Asia/Aqtobe",
"gmtOffset" : 5
},
{
"name" : "Asia/Ashgabat",
"gmtOffset" : 5
},
{
"name" : "Asia/Atyrau",
"gmtOffset" : 5
},
{
"name" : "Asia/Baghdad",
"gmtOffset" : 3
},
{
"name" : "Asia/Bahrain",
"gmtOffset" : 3
},
{
"name" : "Asia/Baku",
"gmtOffset" : 4
},
{
"name" : "Asia/Bangkok",
"gmtOffset" : 7
},
{
"name" : "Asia/Barnaul",
"gmtOffset" : 7
},
{
"name" : "Asia/Beirut",
"gmtOffset" : 3
},
{
"name" : "Asia/Bishkek",
"gmtOffset" : 6
},
{
"name" : "Asia/Brunei",
"gmtOffset" : 8
},
{
"name" : "Asia/Chita",
"gmtOffset" : 9
},
{
"name" : "Asia/Choibalsan",
"gmtOffset" : 8
},
{
"name" : "Asia/Colombo",
"gmtOffset" : 5.5
},
{
"name" : "Asia/Damascus",
"gmtOffset" : 3
},
{
"name" : "Asia/Dhaka",
"gmtOffset" : 6
},
{
"name" : "Asia/Dili",
"gmtOffset" : 9
},
{
"name" : "Asia/Dubai",
"gmtOffset" : 4
},
{
"name" : "Asia/Dushanbe",
"gmtOffset" : 5
},
{
"name" : "Asia/Famagusta",
"gmtOffset" : 3
},
{
"name" : "Asia/Gaza",
"gmtOffset" : 3
},
{
"name" : "Asia/Hebron",
"gmtOffset" : 3
},
{
"name" : "Asia/Ho_Chi_Minh",
"gmtOffset" : 7
},
{
"name" : "Asia/Hong_Kong",
"gmtOffset" : 8
},
{
"name" : "Asia/Hovd",
"gmtOffset" : 7
},
{
"name" : "Asia/Irkutsk",
"gmtOffset" : 8
},
{
"name" : "Asia/Jakarta",
"gmtOffset" : 7
},
{
"name" : "Asia/Jayapura",
"gmtOffset" : 9
},
{
"name" : "Asia/Jerusalem",
"gmtOffset" : 3
},
{
"name" : "Asia/Kabul",
"gmtOffset" : 4.5
},
{
"name" : "Asia/Kamchatka",
"gmtOffset" : 12
},
{
"name" : "Asia/Karachi",
"gmtOffset" : 5
},
{
"name" : "Asia/Kathmandu",
"gmtOffset" : 5.75
},
{
"name" : "Asia/Khandyga",
"gmtOffset" : 9
},
{
"name" : "Asia/Kolkata",
"gmtOffset" : 5.5
},
{
"name" : "Asia/Krasnoyarsk",
"gmtOffset" : 7
},
{
"name" : "Asia/Kuala_Lumpur",
"gmtOffset" : 8
},
{
"name" : "Asia/Kuching",
"gmtOffset" : 8
},
{
"name" : "Asia/Kuwait",
"gmtOffset" : 3
},
{
"name" : "Asia/Macau",
"gmtOffset" : 8
},
{
"name" : "Asia/Magadan",
"gmtOffset" : 11
},
{
"name" : "Asia/Makassar",
"gmtOffset" : 8
},
{
"name" : "Asia/Manila",
"gmtOffset" : 8
},
{
"name" : "Asia/Muscat",
"gmtOffset" : 4
},
{
"name" : "Asia/Nicosia",
"gmtOffset" : 3
},
{
"name" : "Asia/Novokuznetsk",
"gmtOffset" : 7
},
{
"name" : "Asia/Novosibirsk",
"gmtOffset" : 7
},
{
"name" : "Asia/Omsk",
"gmtOffset" : 6
},
{
"name" : "Asia/Oral",
"gmtOffset" : 5
},
{
"name" : "Asia/Phnom_Penh",
"gmtOffset" : 7
},
{
"name" : "Asia/Pontianak",
"gmtOffset" : 7
},
{
"name" : "Asia/Pyongyang",
"gmtOffset" : 9
},
{
"name" : "Asia/Qatar",
"gmtOffset" : 3
},
{
"name" : "Asia/Qyzylorda",
"gmtOffset" : 6
},
{
"name" : "Asia/Riyadh",
"gmtOffset" : 3
},
{
"name" : "Asia/Sakhalin",
"gmtOffset" : 11
},
{
"name" : "Asia/Samarkand",
"gmtOffset" : 5
},
{
"name" : "Asia/Seoul",
"gmtOffset" : 9
},
{
"name" : "Asia/Shanghai",
"gmtOffset" : 8
},
{
"name" : "Asia/Singapore",
"gmtOffset" : 8
},
{
"name" : "Asia/Srednekolymsk",
"gmtOffset" : 11
},
{
"name" : "Asia/Taipei",
"gmtOffset" : 8
},
{
"name" : "Asia/Tashkent",
"gmtOffset" : 5
},
{
"name" : "Asia/Tbilisi",
"gmtOffset" : 4
},
{
"name" : "Asia/Tehran",
"gmtOffset" : 4.5
},
{
"name" : "Asia/Thimphu",
"gmtOffset" : 6
},
{
"name" : "Asia/Tokyo",
"gmtOffset" : 9
},
{
"name" : "Asia/Tomsk",
"gmtOffset" : 7
},
{
"name" : "Asia/Ulaanbaatar",
"gmtOffset" : 8
},
{
"name" : "Asia/Urumqi",
"gmtOffset" : 6
},
{
"name" : "Asia/Ust-Nera",
"gmtOffset" : 10
},
{
"name" : "Asia/Vientiane",
"gmtOffset" : 7
},
{
"name" : "Asia/Vladivostok",
"gmtOffset" : 10
},
{
"name" : "Asia/Yakutsk",
"gmtOffset" : 9
},
{
"name" : "Asia/Yangon",
"gmtOffset" : 6.5
},
{
"name" : "Asia/Yekaterinburg",
"gmtOffset" : 5
},
{
"name" : "Asia/Yerevan",
"gmtOffset" : 4
},
{
"name" : "Atlantic/Azores",
"gmtOffset" : 0
},
{
"name" : "Atlantic/Bermuda",
"gmtOffset" : -3
},
{
"name" : "Atlantic/Canary",
"gmtOffset" : 1
},
{
"name" : "Atlantic/Cape_Verde",
"gmtOffset" : -1
},
{
"name" : "Atlantic/Faroe",
"gmtOffset" : 1
},
{
"name" : "Atlantic/Madeira",
"gmtOffset" : 1
},
{
"name" : "Atlantic/Reykjavik",
"gmtOffset" : 0
},
{
"name" : "Atlantic/South_Georgia",
"gmtOffset" : -2
},
{
"name" : "Atlantic/St_Helena",
"gmtOffset" : 0
},
{
"name" : "Atlantic/Stanley",
"gmtOffset" : -3
},
{
"name" : "Australia/Adelaide",
"gmtOffset" : 9.5
},
{
"name" : "Australia/Brisbane",
"gmtOffset" : 10
},
{
"name" : "Australia/Broken_Hill",
"gmtOffset" : 9.5
},
{
"name" : "Australia/Currie",
"gmtOffset" : 10
},
{
"name" : "Australia/Darwin",
"gmtOffset" : 9.5
},
{
"name" : "Australia/Eucla",
"gmtOffset" : 8.75
},
{
"name" : "Australia/Hobart",
"gmtOffset" : 10
},
{
"name" : "Australia/Lindeman",
"gmtOffset" : 10
},
{
"name" : "Australia/Lord_Howe",
"gmtOffset" : 10.5
},
{
"name" : "Australia/Melbourne",
"gmtOffset" : 10
},
{
"name" : "Australia/Perth",
"gmtOffset" : 8
},
{
"name" : "Australia/Sydney",
"gmtOffset" : 10
},
{
"name" : "Europe/Amsterdam",
"gmtOffset" : 2
},
{
"name" : "Europe/Andorra",
"gmtOffset" : 2
},
{
"name" : "Europe/Astrakhan",
"gmtOffset" : 4
},
{
"name" : "Europe/Athens",
"gmtOffset" : 3
},
{
"name" : "Europe/Belgrade",
"gmtOffset" : 2
},
{
"name" : "Europe/Berlin",
"gmtOffset" : 2
},
{
"name" : "Europe/Bratislava",
"gmtOffset" : 2
},
{
"name" : "Europe/Brussels",
"gmtOffset" : 2
},
{
"name" : "Europe/Bucharest",
"gmtOffset" : 3
},
{
"name" : "Europe/Budapest",
"gmtOffset" : 2
},
{
"name" : "Europe/Busingen",
"gmtOffset" : 2
},
{
"name" : "Europe/Chisinau",
"gmtOffset" : 3
},
{
"name" : "Europe/Copenhagen",
"gmtOffset" : 2
},
{
"name" : "Europe/Dublin",
"gmtOffset" : 1
},
{
"name" : "Europe/Gibraltar",
"gmtOffset" : 2
},
{
"name" : "Europe/Guernsey",
"gmtOffset" : 1
},
{
"name" : "Europe/Helsinki",
"gmtOffset" : 3
},
{
"name" : "Europe/Isle_of_Man",
"gmtOffset" : 1
},
{
"name" : "Europe/Istanbul",
"gmtOffset" : 3
},
{
"name" : "Europe/Jersey",
"gmtOffset" : 1
},
{
"name" : "Europe/Kaliningrad",
"gmtOffset" : 2
},
{
"name" : "Europe/Kiev",
"gmtOffset" : 3
},
{
"name" : "Europe/Kirov",
"gmtOffset" : 3
},
{
"name" : "Europe/Lisbon",
"gmtOffset" : 1
},
{
"name" : "Europe/Ljubljana",
"gmtOffset" : 2
},
{
"name" : "Europe/London",
"gmtOffset" : 1
},
{
"name" : "Europe/Luxembourg",
"gmtOffset" : 2
},
{
"name" : "Europe/Madrid",
"gmtOffset" : 2
},
{
"name" : "Europe/Malta",
"gmtOffset" : 2
},
{
"name" : "Europe/Mariehamn",
"gmtOffset" : 3
},
{
"name" : "Europe/Minsk",
"gmtOffset" : 3
},
{
"name" : "Europe/Monaco",
"gmtOffset" : 2
},
{
"name" : "Europe/Moscow",
"gmtOffset" : 3
},
{
"name" : "Europe/Oslo",
"gmtOffset" : 2
},
{
"name" : "Europe/Paris",
"gmtOffset" : 2
},
{
"name" : "Europe/Podgorica",
"gmtOffset" : 2
},
{
"name" : "Europe/Prague",
"gmtOffset" : 2
},
{
"name" : "Europe/Riga",
"gmtOffset" : 3
},
{
"name" : "Europe/Rome",
"gmtOffset" : 2
},
{
"name" : "Europe/Samara",
"gmtOffset" : 4
},
{
"name" : "Europe/San_Marino",
"gmtOffset" : 2
},
{
"name" : "Europe/Sarajevo",
"gmtOffset" : 2
},
{
"name" : "Europe/Saratov",
"gmtOffset" : 4
},
{
"name" : "Europe/Simferopol",
"gmtOffset" : 3
},
{
"name" : "Europe/Skopje",
"gmtOffset" : 2
},
{
"name" : "Europe/Sofia",
"gmtOffset" : 3
},
{
"name" : "Europe/Stockholm",
"gmtOffset" : 2
},
{
"name" : "Europe/Tallinn",
"gmtOffset" : 3
},
{
"name" : "Europe/Tirane",
"gmtOffset" : 2
},
{
"name" : "Europe/Ulyanovsk",
"gmtOffset" : 4
},
{
"name" : "Europe/Uzhgorod",
"gmtOffset" : 3
},
{
"name" : "Europe/Vaduz",
"gmtOffset" : 2
},
{
"name" : "Europe/Vatican",
"gmtOffset" : 2
},
{
"name" : "Europe/Vienna",
"gmtOffset" : 2
},
{
"name" : "Europe/Vilnius",
"gmtOffset" : 3
},
{
"name" : "Europe/Volgograd",
"gmtOffset" : 3
},
{
"name" : "Europe/Warsaw",
"gmtOffset" : 2
},
{
"name" : "Europe/Zagreb",
"gmtOffset" : 2
},
{
"name" : "Europe/Zaporozhye",
"gmtOffset" : 3
},
{
"name" : "Europe/Zurich",
"gmtOffset" : 2
},
{
"name" : "Indian/Antananarivo",
"gmtOffset" : 3
},
{
"name" : "Indian/Chagos",
"gmtOffset" : 6
},
{
"name" : "Indian/Christmas",
"gmtOffset" : 7
},
{
"name" : "Indian/Cocos",
"gmtOffset" : 6.5
},
{
"name" : "Indian/Comoro",
"gmtOffset" : 3
},
{
"name" : "Indian/Kerguelen",
"gmtOffset" : 5
},
{
"name" : "Indian/Mahe",
"gmtOffset" : 4
},
{
"name" : "Indian/Maldives",
"gmtOffset" : 5
},
{
"name" : "Indian/Mauritius",
"gmtOffset" : 4
},
{
"name" : "Indian/Mayotte",
"gmtOffset" : 3
},
{
"name" : "Indian/Reunion",
"gmtOffset" : 4
},
{
"name" : "Pacific/Apia",
"gmtOffset" : 13
},
{
"name" : "Pacific/Auckland",
"gmtOffset" : 12
},
{
"name" : "Pacific/Bougainville",
"gmtOffset" : 11
},
{
"name" : "Pacific/Chatham",
"gmtOffset" : 12.75
},
{
"name" : "Pacific/Chuuk",
"gmtOffset" : 10
},
{
"name" : "Pacific/Easter",
"gmtOffset" : -6
},
{
"name" : "Pacific/Efate",
"gmtOffset" : 11
},
{
"name" : "Pacific/Enderbury",
"gmtOffset" : 13
},
{
"name" : "Pacific/Fakaofo",
"gmtOffset" : 13
},
{
"name" : "Pacific/Fiji",
"gmtOffset" : 12
},
{
"name" : "Pacific/Funafuti",
"gmtOffset" : 12
},
{
"name" : "Pacific/Galapagos",
"gmtOffset" : -6
},
{
"name" : "Pacific/Gambier",
"gmtOffset" : -9
},
{
"name" : "Pacific/Guadalcanal",
"gmtOffset" : 11
},
{
"name" : "Pacific/Guam",
"gmtOffset" : 10
},
{
"name" : "Pacific/Honolulu",
"gmtOffset" : -10
},
{
"name" : "Pacific/Kiritimati",
"gmtOffset" : 14
},
{
"name" : "Pacific/Kosrae",
"gmtOffset" : 11
},
{
"name" : "Pacific/Kwajalein",
"gmtOffset" : 12
},
{
"name" : "Pacific/Majuro",
"gmtOffset" : 12
},
{
"name" : "Pacific/Marquesas",
"gmtOffset" : -9.5
},
{
"name" : "Pacific/Midway",
"gmtOffset" : -11
},
{
"name" : "Pacific/Nauru",
"gmtOffset" : 12
},
{
"name" : "Pacific/Niue",
"gmtOffset" : -11
},
{
"name" : "Pacific/Norfolk",
"gmtOffset" : 11
},
{
"name" : "Pacific/Noumea",
"gmtOffset" : 11
},
{
"name" : "Pacific/Pago_Pago",
"gmtOffset" : -11
},
{
"name" : "Pacific/Palau",
"gmtOffset" : 9
},
{
"name" : "Pacific/Pitcairn",
"gmtOffset" : -8
},
{
"name" : "Pacific/Pohnpei",
"gmtOffset" : 11
},
{
"name" : "Pacific/Port_Moresby",
"gmtOffset" : 10
},
{
"name" : "Pacific/Rarotonga",
"gmtOffset" : -10
},
{
"name" : "Pacific/Saipan",
"gmtOffset" : 10
},
{
"name" : "Pacific/Tahiti",
"gmtOffset" : -10
},
{
"name" : "Pacific/Tarawa",
"gmtOffset" : 12
},
{
"name" : "Pacific/Tongatapu",
"gmtOffset" : 13
},
{
"name" : "Pacific/Wake",
"gmtOffset" : 12
},
{
"name" : "Pacific/Wallis",
"gmtOffset" : 12
},
{
"name" : "UTC",
"gmtOffset" : 0
}
],
"wasLicense": "true",
"wasFQDNCount": 5,
"postgresConnStatus": "true",
"postgresConnectionType": "internal",
"VulnerabilityIntelligenceEnabled": "true"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1565127825
}
/system/debug
/tes/system/debug
/tes/system/debug in only available in Tenable Enclave Security
Methods
GET
Gets the list of debug items.
Request Query Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : [
{
"id" : "0",
"name" : "Accept Risk",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "1",
"name" : "Activity Log",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "true"
},
{
"id" : "2",
"name" : "Apply All Risk",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "3",
"name" : "Convert Compliance",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "4",
"name" : "Convert Name DB",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "5",
"name" : "Convert Repositories",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "6",
"name" : "Custom Plugin Upload",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "7",
"name" : "DB Locks",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "8",
"name" : "Dev Migration",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "9",
"name" : "Evaluate ARC",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "10",
"name" : "Evaluate ARC Policy Statement Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "11",
"name" : "Evaluate AR Sync Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "12",
"name" : "Evaluate Blackout Window Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "13",
"name" : "Evaluate Dashboard Component Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "14",
"name" : "Evaluate Dashboard Element",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "15",
"name" : "Evaluate Matrix Cluster",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "16",
"name" : "Evaluate Query Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "17",
"name" : "Evaluate Report Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "18",
"name" : "Evaluate Scan Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "19",
"name" : "Expire Accepted Risk",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "20",
"name" : "Export",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "21",
"name" : "Feed Update",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "22",
"name" : "Flush Vulns",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "23",
"name" : "IDS Correlations",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "24",
"name" : "IDS Signatures",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "25",
"name" : "Import",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "26",
"name" : "Import ARC",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "27",
"name" : "Import Dashboard",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "28",
"name" : "Import Mobile",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "29",
"name" : "Import Report",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "30",
"name" : "Industrial Plugin Update",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "31",
"name" : "Industrial Plugin Update Testing",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "32",
"name" : "Industrial Results",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "33",
"name" : "Job Activity",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "34",
"name" : "Job Daemon",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "35",
"name" : "LCE Plugin Update",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "36",
"name" : "LCE Status",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "37",
"name" : "Licensing",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "38",
"name" : "Mark Assets Prepared",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "39",
"name" : "Migrate User Files",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "40",
"name" : "Migration",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "41",
"name" : "Mobile Scan",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "42",
"name" : "Nightly Cleanup",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "43",
"name" : "NNM Results",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "44",
"name" : "Parse Nessus",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "45",
"name" : "Passive Plugin Update",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "46",
"name" : "Passive Plugin Update Testing",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "47",
"name" : "Password Convert",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "48",
"name" : "Patch",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "49",
"name" : "Performance Log",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "50",
"name" : "Plugin Update",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "51",
"name" : "Plugin Update Testing",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "52",
"name" : "Prepare Assets",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "53",
"name" : "Publishing",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "54",
"name" : "Recast Risk",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "55",
"name" : "Remote Client Tools",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "56",
"name" : "Reporting",
"category" : "common",
"sizeWarning" : "true",
"enabled" : "false"
},
{
"id" : "57",
"name" : "Resolve Host Names",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "58",
"name" : "Run Alert",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "59",
"name" : "Save Policy",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "60",
"name" : "Scan",
"category" : "common",
"sizeWarning" : "true",
"enabled" : "false"
},
{
"id" : "61",
"name" : "Scanner Status",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "62",
"name" : "Session",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "63",
"name" : "Simple Activity",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "64",
"name" : "Synchronize Agent Results",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "65",
"name" : "Synchronize Repository",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "66",
"name" : "Take Repository Snapshots",
"category" : "uncommon",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "67",
"name" : "Update DNS Assets",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "68",
"name" : "Update LCE Silos",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "69",
"name" : "Update LCE Types",
"category" : "rare",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "70",
"name" : "Update LDAP Assets",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
},
{
"id" : "71",
"name" : "Disk I/O Errors",
"category" : "common",
"sizeWarning" : "false",
"enabled" : "false"
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1551190238
}
PATCH
Edits one or more debug items. Only the debug items specified are modified.
Request Parameters
Expand{
"debugs" : [
{
"id" : <number>,
"enabled" : <string> "false" | "true"
}
...
]
}
Example Response
See /system/debug::GET/system/diagnostics
The /system/diagnostics resource.
Methods
GET
Gets the system diagnostics information.
Fields Parameter
ExpandThe fields parameter should be specified along the query string, and it takes the syntax
?fields=<field>,...
Allowed Fields
**statusJava
**statusRPM
**statusDisk
**statusThresholdDisk
**statusLastChecked
**diagnosticsGenerated
**diagnosticsGenerateState
**touchDebuggingEnabled
**migrationFailure
**postgresConnStatus
Legend
* = always comes back
** = comes back if fields list not specified on GET all
Request Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : {
"statusJava" : "true",
"statusRPM" : "true",
"statusDisk" : "true",
"statusThresholdDisk" : "5%",
"statusLastChecked" : "1425532201",
"diagnosticsGenerated" : 1425563166,
"diagnosticsGenerateState" : "-1,
"touchDebuggingEnabled" : false,
"migrationFailure" : false,
"postgresConnStatus": "true"
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1425571142
}
/system/diagnostics/generate
The /system/diagnostics/generate resource.
Methods
POST
Starts an on-demand, diagnostics analysis for the System that can be downloaded after its job completes.
Request Parameters
Expand{
"task" : <string> "appStatus" | "diagnosticsFile",
"tags" : <string> DEFAULT "",
...
}
type "diagnosticsFile"
...
"options" : [
{
<option:string> "all" | "apacheLog" | "configuration" | "dependencies" | "dirlist" | "environment" | "installLog" | "logs" | "sanitize" | "scans" | "serverConf" | "setup" | "sysinfo" | "upgradeLog"
}...
] NOT EMPTY,
...
Example Response
Expand{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1425574362
}
/system/diagnostics/download
The /system/diagnostics/download resource.
Methods
POST
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
POST
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
Expand{
"debugLogsTimeframe" : <number>,
}
Timeframe in seconds
Example Response
Expand{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1425574362
}
/system/debuglogs/download
The /system/debuglogs/download resource.
Methods
POST
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
GET
Retrieves the current Locale set in Tenable.sc.
Request Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : {
"code" : "ja",
"name" : "Japanese",
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1494360454
}
PATCH
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
Expand{
"PluginLocale" : <String>
}
Example Response
Expand{
"type" : "regular",
"response" : "ja",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1494360819
}
/system/locales
Methods
GET
States the current locale set in Tenable.sc.
Request Parameters
None
Example Response
Expand{
"type" : "regular",
"response" : {
"ja" : {
"code" : "ja",
"name" : "Japanese"
},
"zh_CN" : {
"code" : "zh_CN",
"name" : "Chinese (Simplified)"
},
"zh_TW" : {
"code" : "zh_TW",
"name" : "Chinese (Traditional)"
}
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1506952831
}
/system/logFiles
Methods
GET
Gets the list of log files available to the user
Request Parameters
None
Example Response for Admins
Expand{
"type": "regular",
"response": [
{
"organization": {
"id": 0,
"name": "Application",
"description": ""
},
"basenames": [
"202106"
]
},
{
"organization": {
"id": "1",
"name": "Org",
"description": ""
},
"basenames": [
"202106"
]
}
],
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1624370508
}
Example Response for Security Managers
Expand{
"type": "regular",
"response": [
{
"basenames": [
"202106"
]
}
],
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1624371093
}
/system/logs
Methods
POST
Returns the available log messages based on user permissions and the query filters
Request Parameters
Expand{
"date" : scLog basename (eg. "201412") | "all",
"query": {
"startOffset" : <number>,
"endOffset" : <number>,
"scrollModel" : <string> ("virtual"|"paged", default "virtual"),
"filters" : [
{
"filterName" : "keywords",
"operator" : "=",
"value" : <string>
},
{
"filterName" : "severity",
"value" : {
"id" : <number> [0-2],
"operator" : "=",
"name":"INFO|WARNING|CRITICAL"
}
},
{
"filterName" : "module",
"operator" : "=",
"value" : <string> (eg. "auth")
},
{
"filterName" : "organization",
"value" : {
"id" : <number>
}
}
]
}
}
Example Response
Expand{
"type": "regular",
"response": {
"skip": [],
"totalRecords": 124,
"endOffset": 3,
"results": [
{
"rawLog": "Tue, 22 Jun 2021 09:42:00 -0400|expireAcceptedRisk|message|INFO|0|Expire accepted risk job #813 has ended.\n",
"message": "Expire accepted risk job #813 has ended.",
"organization": {
"id": 0,
"name": "Application",
"description": ""
},
"severity": {
"id": "0",
"name": "INFO",
"description": "Information"
},
"module": "message",
"source": "expireAcceptedRisk",
"date": "Tue, 22 Jun 2021 09:42:00 -0400"
},
{
"rawLog": "Tue, 22 Jun 2021 09:42:00 -0400|expireAcceptedRisk|message|INFO|0|Expire accepted risk job #813 starting...\n",
"message": "Expire accepted risk job #813 starting...",
"organization": {
"id": 0,
"name": "Application",
"description": ""
},
"severity": {
"id": "0",
"name": "INFO",
"description": "Information"
},
"module": "message",
"source": "expireAcceptedRisk",
"date": "Tue, 22 Jun 2021 09:42:00 -0400"
},
{
"rawLog": "Tue, 22 Jun 2021 09:40:48 -0400|admin|auth|INFO|0|Successful login for 'admin' from 192.168.36.43 (authentication type: tns).\n",
"message": "Successful login for 'admin' from 192.168.36.43 (authentication type: tns).",
"organization": {
"id": 0,
"name": "Application",
"description": ""
},
"severity": {
"id": "0",
"name": "INFO",
"description": "Information"
},
"module": "auth",
"source": "admin",
"date": "Tue, 22 Jun 2021 09:40:48 -0400"
}
]
},
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1624369910
}
/system/logs/download
Methods
POST
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
Expand{
"date" : scLog basename (eg. "201412") | "all",
"query": {
"startOffset" : <number>,
"endOffset" : <number>,
"filters" : [
{
"filterName" : "keywords",
"operator" : "=",
"value" : <string>
},
{
"filterName" : "severity",
"value" : {
"id" : <number> [0-2],
"operator" : "=",
"name":"INFO|WARNING|CRITICAL"
}
},
{
"filterName" : "module",
"operator" : "=",
"value" : <string> (eg. "auth")
},
{
"filterName" : "organization",
"value" : {
"id" : <number>
}
}
]
}
}
Example Response
Expand"Date","Initiator","Module","Severity","Organization","Message" "Thu, 24 Jun 2021 12:26:50 -0400","admin","auth","INFO","Application","Successful login for 'admin' from 192.168.37.145 (authentication type: tns)." "Thu, 24 Jun 2021 11:42:00 -0400","expireAcceptedRisk","message","INFO","Application","Expire accepted risk job #2181 has ended." "Thu, 24 Jun 2021 11:42:00 -0400","expireAcceptedRisk","message","INFO","Application","Expire accepted risk job #2181 starting..."
/system/logs/modules
Methods
GET
Get a full list of all modules which output to the System Log.
Request Parameters
ExpandNone
Example Response
Expand{
"type": "regular",
"response": [
{
"id": "acceptRisk"
},
{
"id": "acceptRiskRule"
},
{
"id": "acr"
},
{
"id": "admin"
},
{
"id": "agentGroup"
},
{
"id": "agentResultsSync"
},
{
"id": "agentScan"
},
{
"id": "alert"
},
{
"id": "apikey"
},
{
"id": "arc"
},
{
"id": "asset"
},
{
"id": "attributeSet"
},
{
"id": "auditFile"
},
{
"id": "auth"
},
{
"id": "calculate_assets_rbvm"
},
{
"id": "configuration"
},
{
"id": "convert_compliance"
},
{
"id": "create_diff"
},
{
"id": "credential"
},
{
"id": "customPassivePlugin"
},
{
"id": "customPlugin"
},
{
"id": "daemons"
},
{
"id": "dashboard"
},
{
"id": "data"
},
{
"id": "database"
},
{
"id": "defragment_vulns"
},
{
"id": "diagnostics"
},
{
"id": "diskprimer"
},
{
"id": "error"
},
{
"id": "events"
},
{
"id": "export_repo_to_hostsdb"
},
{
"id": "feed"
},
{
"id": "file"
},
{
"id": "filesystem"
},
{
"id": "flush_vulns"
},
{
"id": "freezeWindow"
},
{
"id": "get-random-bytes"
},
{
"id": "group"
},
{
"id": "heartbeat"
},
{
"id": "import"
},
{
"id": "iprange"
},
{
"id": "job"
},
{
"id": "lce"
},
{
"id": "lceClients"
},
{
"id": "lcePlugin"
},
{
"id": "lce_import"
},
{
"id": "ldap"
},
{
"id": "logging"
},
{
"id": "luminRepositories"
},
{
"id": "message"
},
{
"id": "mobile"
},
{
"id": "nessusResults"
},
{
"id": "organization"
},
{
"id": "passivePlugin"
},
{
"id": "passiveScanner"
},
{
"id": "plugin"
},
{
"id": "policy"
},
{
"id": "prepareassets"
},
{
"id": "prepare_rep_assets"
},
{
"id": "publishingSite"
},
{
"id": "pvs_import"
},
{
"id": "query"
},
{
"id": "rawLogs"
},
{
"id": "recastRisk"
},
{
"id": "recastRiskRule"
},
{
"id": "report"
},
{
"id": "reportImage"
},
{
"id": "reportResult"
},
{
"id": "repository"
},
{
"id": "resource"
},
{
"id": "riskRules"
},
{
"id": "role"
},
{
"id": "saml"
},
{
"id": "scan"
},
{
"id": "scanner"
},
{
"id": "scanResult"
},
{
"id": "sci"
},
{
"id": "sciScanner"
},
{
"id": "sciZone"
},
{
"id": "SCRepoGetNextHostVulnsTestSuite"
},
{
"id": "showvulns"
},
{
"id": "showvulns-archive"
},
{
"id": "showvulns-individual"
},
{
"id": "showvulns-mobile"
},
{
"id": "sshKey"
},
{
"id": "status"
},
{
"id": "style"
},
{
"id": "syncAssetsToIO"
},
{
"id": "syncVulnsToIO"
},
{
"id": "system"
},
{
"id": "ticket"
},
{
"id": "universal_assign_vuln_uuid"
},
{
"id": "universal_merge_assets"
},
{
"id": "user"
},
{
"id": "userPrefs"
},
{
"id": "vuln"
},
{
"id": "vulnRoutingRule"
},
{
"id": "zone"
}
],
"error_code": 0,
"error_msg": "",
"warnings": [],
"timestamp": 1688590913
}
/system/fips
Methods
GET
Retrieves the current status of FIPS in Tenable.sc.
Request Parameters
None
Example Response
Expand{
"type":"regular",
"response":{
"apacheStatus":"true",
"fipsMode":"true",
"apacheStatusText":""
},
"error_code":0,
"error_msg":"",
"warnings":[
],
"timestamp":1668631473
}
POST
Set the status of FIPS in Tenable.sc.
NOTE #1: Tenable.sc will need to be restarted for this to take affect.
Request Parameters
Expand{
"fipsMode":"false"
}
Example Response
Expand{
"type":"regular",
"response":{
"apacheStatus":"true",
"fipsMode":"false",
"apacheStatusText":""
},
"error_code":0,
"error_msg":"",
"warnings":[
],
"timestamp":1668632070
}