Get template details

GET {{baseUrl}}/editor/:type/templates/:template_uuid

Gets details for the specified template.

Requires STANDARD [32] user permissions. See Permissions.

RESPONSES

status: OK

{"is_was":null,"user_permissions":null,"owner":null,"title":"Host Discovery","is_agent":null,"uuid":"bbd4f805-3966-d464-b2d1-0079eb89d69708c3a05ec2812bcf","settings":{"basic":{"inputs":[{"type":"entry","name":"Name","id":"name","required":true},{"type":"textarea","name":"Description","id":"description"},{"type":"select","id":"include_aggregate","name":"Scan results","default":true,"options":[{"name":"Keep private","value":"false"},{"name":"Show in dashboard","value":"true"}]},{"type":"select","id":"folder_id","name":"Folder","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"}]},{"type":"select","id":"scanner_id","name":"Scanner","default":null,"options":[{"id":"00000000-0000-0000-0000-00000000000000000000000000001","name":"US Cloud Scanner","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44","name":"AP Singapore Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"cdf44a84-b547-b66c-d997-920aa1e897cc7165fe2e344196bb","name":"Demo Scanner","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef","name":"EU Frankfurt Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"15e29fb5-c378-4803-37f7-67752912247e812e6cf942b4fd2e","name":"US East Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"},{"id":"37b315c1-f31f-cc8e-7e78-585c609fc1d7eba88f8d1e7d24b3","name":"US West Cloud Scanners","type":"local","network_name":"Default","linked":true,"status":"on"}]},{"type":"multi_select","deprecated_by":"target_groups","id":"asset_lists","name":"Target Groups","default":[],"options":[{"acls":[{"permissions":64,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"system","name":"nessus_ms_agent","id":1,"type":"user"},{"permissions":64,"owner":0,"display_name":"user@example.com","name":"user@example.com","id":2,"type":"user"}],"default_list":0,"type":"system","members":"host.domain.com, host1.domain.com","name":"modified_test_group_yet_again_and-again","owner":"nessus_ms_agent","shared":1,"user_permissions":64,"last_modification_date":1533583518,"creation_date":1533577166,"owner_id":1,"id":13},{"acls":[{"permissions":64,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"system","name":"nessus_ms_agent","id":1,"type":"user"},{"permissions":64,"owner":0,"display_name":"user@example.com","name":"user@example.com","id":2,"type":"user"}],"default_list":0,"type":"system","members":"testtest1","name":"test group","owner":"nessus_ms_agent","shared":1,"user_permissions":64,"last_modification_date":1533580228,"creation_date":1533246042,"owner_id":1,"id":12}]},{"type":"textarea","id":"text_targets","name":"Targets","placeholder":"Example: 172.204.81.57-172.204.81.60, 172.156.65.8/24, test.com","required":true},{"type":"file","id":"file_targets","name":"Upload Targets"}],"title":"Basic","groups":[{"title":"Schedule","name":"schedule"},{"inputs":[{"type":"textarea","name":"Email Recipient(s)","placeholder":"Example: me@example.com, you@example.com"}],"title":"Notifications","name":"email","filters":[]},{"title":"Permissions","name":"permissions","acls":null}],"sections":[]},"discovery":{"inputs":null,"modes":{"id":"discovery_mode","name":"mode","type":"ui_radio","default":"Host enumeration","options":[{"desc":"\u003cul\u003e\u003cli\u003eGeneral Settings:\u003cul\u003e\u003cli\u003eAlways test the local Nessus host\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePing hosts using:\u003cul\u003e\u003cli\u003eTCP\u003c/li\u003e\u003cli\u003eARP\u003c/li\u003e\u003cli\u003eICMP (2 retries)\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","name":"Host enumeration"},{"desc":"\u003cul\u003e\u003cli\u003eGeneral Settings:\u003cul\u003e\u003cli\u003eAlways test the local Nessus host\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePing hosts using:\u003cul\u003e\u003cli\u003eTCP\u003c/li\u003e\u003cli\u003eARP\u003c/li\u003e\u003cli\u003eICMP\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","name":"OS Identification"},{"desc":"\u003cul\u003e\u003cli\u003eGeneral Settings:\u003cul\u003e\u003cli\u003eAlways test the local Nessus host\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePort Scanner Settings:\u003cul\u003e\u003cli\u003eScan common ports\u003c/li\u003e\u003cli\u003eUse netstat if credentials are provided\u003c/li\u003e\u003cli\u003eUse SYN scanner if necessary\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePing hosts using:\u003cul\u003e\u003cli\u003eTCP\u003c/li\u003e\u003cli\u003eARP\u003c/li\u003e\u003cli\u003eICMP (2 retries)\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","name":"Port scan (common ports)"},{"desc":"\u003cul\u003e\u003cli\u003eGeneral Settings:\u003cul\u003e\u003cli\u003eAlways test the local Nessus host\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePort Scanner Settings:\u003cul\u003e\u003cli\u003eScan all ports (1-65535)\u003c/li\u003e\u003cli\u003eUse netstat if credentials are provided\u003c/li\u003e\u003cli\u003eUse SYN scanner if necessary\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003ePing hosts using:\u003cul\u003e\u003cli\u003eTCP\u003c/li\u003e\u003cli\u003eARP\u003c/li\u003e\u003cli\u003eICMP (2 retries)\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","name":"Port scan (all ports)"},{"desc":"\u003cul\u003e\u003cli\u003eChoose your own discovery settings.\u003c/li\u003e\u003c/ul\u003e","name":"Custom"}]},"title":"Discovery","groups":[{"inputs":[{"type":"ui_checkbox","name":"Ping the remote host","id":"ping_the_remote_host","default":"yes","options":[{"inputs":null,"name":"no"},{"inputs":null,"name":"yes","sections":[{"inputs":[{"type":"checkbox","id":"fast_network_discovery","label":"Use fast network discovery","default":"no","hint":"If a host responds to ping, Nessus attempts to avoid false positives, performing additional tests to verify the response did not come from a proxy or load balancer. Fast network discovery bypasses those additional tests."}],"title":"General Settings","name":"general"},{"inputs":[{"type":"checkbox","id":"arp_ping","label":"ARP","default":"yes"},{"name":"TCP","inputs":[{"type":"medium-entry","name":"Destination ports","id":"tcp_ping_dest_ports","default":"built-in"}],"type":"ui_group","id":"tcp_ping","default":"yes"},{"name":"ICMP","inputs":[{"type":"checkbox","id":"icmp_unreach_means_host_down","label":"Assume ICMP unreachable from the gateway means the host is down","default":"no"},{"type":"medium-entry","name":"Maximum number of retries","id":"icmp_ping_retries","default":"2","regex":"^\\d+$"}],"type":"ui_group","id":"icmp_ping","default":"yes"},{"type":"checkbox","id":"udp_ping","label":"UDP","default":"no"}],"title":"Ping Methods","name":"protocols"}]}]}],"title":"Host Discovery","name":"host_discovery","sections":[{"inputs":[{"type":"checkbox","id":"scan_network_printers","label":"Scan Network Printers","default":"no"},{"type":"checkbox","id":"scan_netware_hosts","label":"Scan Novell Netware hosts","default":"no"},{"type":"checkbox","id":"scan_ot_devices","label":"Scan Operational Technology devices","default":"no"}],"title":"Fragile Devices","name":"fragile_devices"},{"inputs":[{"type":"file","name":"List of MAC addresses","id":"wol_mac_addresses","callback":"wol_mac_upload"},{"type":"medium-entry","name":"Boot time wait (in minutes)","id":"wol_wait_time","default":"5","regex":"^\\d+$"}],"title":"Wake-on-LAN","name":"wol"},{"inputs":[{"type":"radio","name":"Network Type","id":"network_type","options":["Mixed (use RFC 1918)","Private LAN","Public WAN (Internet)"],"default":"Mixed (use RFC 1918)"}],"title":"Network Type","name":"network_type"}]},{"inputs":null,"title":"Port Scanning","name":"network_discovery","sections":[{"inputs":[{"type":"checkbox","id":"unscanned_closed","label":"Consider unscanned ports as closed","default":"no"},{"type":"medium-entry","id":"portscan_range","label":"Port scan range:","default":"default"}],"title":"Ports","name":"ports"},{"inputs":[{"id":"tcp_scanner","type":"ui_group","inputs":[{"type":"radio-group","id":"tcp_firewall_detection","label":"Override automatic firewall detection","default":"Automatic (normal)","options":["Automatic (normal)","Do not detect RST rate limitation (soft)","Ignore closed ports (aggressive)","Disabled (softer)"],"optionsLabels":["","Use soft detection","Use aggressive detection","Disable detection"]}],"no_windows":true,"no_darwin":true,"default":"no","name":"TCP"},{"name":"SYN","inputs":[{"type":"radio-group","id":"syn_firewall_detection","label":"Override automatic firewall detection","default":"Automatic (normal)","options":["Automatic (normal)","Do not detect RST rate limitation (soft)","Ignore closed ports (aggressive)","Disabled (softer)"],"optionsLabels":["","Use soft detection","Use aggressive detection","Disable detection"]}],"type":"ui_group","id":"syn_scanner","default":"yes"},{"type":"checkbox","id":"udp_scanner","label":"UDP","default":"no","hint":"Due to the nature of the protocol, it is generally not possible for a port scanner to tell the difference between open and filtered UDP ports.  Enabling the UDP port scanner may dramatically increase the scan time and produce unreliable results. Consider using the netstat or SNMP port enumeration options instead if possible."}],"title":"Network Port Scanners","name":"network_scanners"}]}],"sections":[]},"report":{"inputs":null,"modes":[{"desc":"\u003cul\u003e\u003cli\u003eReport processing:\u003cul\u003e\u003cli\u003eNormal report verbosity\u003c/li\u003e\u003cli\u003eSilent dependencies\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003cli\u003eReport output:\u003cul\u003e\u003cli\u003eAllow users to edit scan results\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","id":"default","name":"Default","default":true},{"desc":"\u003cul\u003e\u003cli\u003eReport output:\u003cul\u003e\u003cli\u003eAllow users to edit scan results\u003c/li\u003e\u003c/ul\u003e\u003c/li\u003e\u003c/ul\u003e","id":"default_output","name":"Default","default":true},{"desc":"\u003cul\u003e\u003cli\u003eChoose your own report settings.\u003c/li\u003e\u003c/ul\u003e","custom":true,"id":"custom","name":"Custom"}],"title":"Report","groups":[],"sections":[{"inputs":[{"type":"checkbox","id":"reverse_lookup","label":"Designate hosts by their DNS name","default":"no"},{"type":"checkbox","id":"log_live_hosts","label":"Display hosts that respond to ping","default":"yes"},{"type":"checkbox","id":"display_unreachable_hosts","label":"Display unreachable hosts","default":"no"}],"title":"Output","name":"report_output"}]}},"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":"discovery"}