Files
shuffle-cracked/app_gen/openapi-parsers/other/TIO-API-Web-Application-Scanning.json
T
2020-05-11 19:17:35 +02:00

1 line
202 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{"openapi":"3.0.0","info":{"title":"Web Application Scanning","version":"1.0.0"},"security":[{"cloud":[]}],"servers":[{"url":"https://cloud.tenable.com"}],"components":{"securitySchemes":{"cloud":{"type":"apiKey","in":"header","name":"X-ApiKeys","description":"Format - accessKey=ACCESS_KEY;secretKey=SECRET_KEY"}}},"x-samples-languages":["python","curl","node","powershell","ruby","javascript","objectivec","java","php","csharp","go","swift","kotlin"],"paths":{"/assets":{"get":{"summary":"List assets","description":"Lists up to 5000 assets, including non-WAS assets.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-assets-list-assets","tags":["Assets"],"responses":{"200":{"description":"Returns a list of assets.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the asset."},"bios_uuid":{"type":"string","description":"BIOS UUID of the asset."},"ipv4":{"description":"A list of ipv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of ipv6 addresses for the asset.","type":"array","items":{"type":"string"}},"hostname":{"description":"A list of hostnames for the asset.","type":"array","items":{"type":"string"}},"fqdn":{"description":"A list of FQDNs for the asset.","type":"array","items":{"type":"string"}},"ssh_fingerprint":{"type":"string","description":"The SSH fingerprint for the asset."},"mac_address":{"description":"A list of MAC addresses for the asset.","type":"array","items":{"type":"string"}},"netbios_name":{"type":"string","description":"The NetBIOS name for the asset."},"operating_system":{"type":"string","description":"The operating system installed on the asset."},"system_type":{"type":"string","description":"The system architecture (x86) of the asset."}}}},"examples":{"response":{"value":{"assets":[{"id":"31e37f64-cf0f-4ba0-9359-f5094a92352b","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":[],"netbios_name":["S11C"],"operating_system":["Microsoft Windows Server 2008 R2 Datacenter Service Pack 1"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]},{"id":"7e35af00-a3f0-4d43-a354-0638ba2b05ae","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":["freebsd11.dc.demo.io"],"netbios_name":[],"operating_system":["FreeBSD 11.1"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]},{"id":"466934be-abb4-4fa9-b8b8-27ace85e5523","has_agent":false,"last_seen":"2018-11-28T17:28:28.000Z","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:25.000Z","last_seen":"2018-11-28T17:28:28.000Z"}],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":["fedorawork27.dc.demo.io"],"netbios_name":[],"operating_system":["Linux Kernel 4.13.9-300.fc27.x86_64 on Fedora release 27 (Twenty Seven)"],"agent_name":[],"aws_ec2_name":[],"mac_address":[]}],"total":3}}}}}},"403":{"description":"Returned if the user does not have permission to list assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/assets/{asset_uuid}":{"get":{"summary":"Get asset information","description":"Gets information about the specified asset.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-assets-asset-info","tags":["Assets"],"parameters":[{"description":"The UUID of the asset.","required":true,"name":"asset_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of assets.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the asset."},"bios_uuid":{"type":"string","description":"BIOS UUID of the asset."},"ipv4":{"description":"A list of ipv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of ipv6 addresses for the asset.","type":"array","items":{"type":"string"}},"hostname":{"description":"A list of hostnames for the asset.","type":"array","items":{"type":"string"}},"fqdn":{"description":"A list of FQDNs for the asset.","type":"array","items":{"type":"string"}},"ssh_fingerprint":{"type":"string","description":"The SSH fingerprint for the asset."},"mac_address":{"description":"A list of MAC addresses for the asset.","type":"array","items":{"type":"string"}},"netbios_name":{"type":"string","description":"The NetBIOS name for the asset."},"operating_system":{"type":"string","description":"The operating system installed on the asset."},"system_type":{"type":"string","description":"The system architecture (x86) of the asset."}}},"examples":{"response":{"value":{"id":"f56168ed-b719-4273-b58c-a340a09ffbce","has_agent":false,"created_at":"2018-11-28T15:01:01.618Z","updated_at":"2018-11-28T15:01:01.618Z","first_seen":"2018-11-28T15:00:57.000Z","last_seen":"2018-11-28T15:00:57.000Z","last_authenticated_scan_date":"2018-11-28T15:00:57.000Z","last_licensed_scan_date":"2018-11-28T15:00:57.000Z","sources":[{"name":"NESSUS_SCAN","first_seen":"2018-11-28T15:00:57.000Z","last_seen":"2018-11-28T15:00:57.000Z"}],"tags":[],"network_id":["00000000-0000-0000-0000-000000000000"],"ipv4":["172.204.81.57"],"ipv6":[],"fqdn":["kubernetes.ad.demo.io"],"mac_address":["aa:e6:57:2f:b3:13","ca:0f:69:8b:c8:ff","8a:83:e4:13:69:96","1e:1f:92:66:12:63","02:42:97:86:cb:b3","46:eb:64:68:6d:7d","6a:7b:e7:9e:a2:0e","f6:27:2f:17:12:bd","00:50:56:a6:6a:a4","a6:8c:f1:b7:2d:1d","16:dd:64:f9:12:6e"],"netbios_name":["kubernetes.ad.demo.io"],"operating_system":["Linux Kernel 3.10.0-862.14.4.el7.x86_64 on CentOS Linux release 7.5.1804 (Core)"],"system_type":["general-purpose"],"tenable_uuid":["dea43dad16684f8a93e88bbd6b30a35a"],"hostname":["kubernetes.ad.demo.io"],"agent_name":[],"bios_uuid":["42263460-6fee-53cb-7e3e-44c8304da18e"],"aws_ec2_instance_id":[],"aws_ec2_instance_ami_id":[],"aws_owner_id":[],"aws_availability_zone":[],"aws_region":[],"aws_vpc_id":[],"aws_ec2_instance_group_name":[],"aws_ec2_instance_state_name":[],"aws_ec2_instance_type":[],"aws_subnet_id":[],"aws_ec2_product_code":[],"aws_ec2_name":[],"azure_vm_id":[],"azure_resource_id":[],"gcp_project_id":[],"gcp_zone":[],"gcp_instance_id":[],"ssh_fingerprint":[],"mcafee_epo_guid":[],"mcafee_epo_agent_guid":[],"qualys_asset_id":[],"qualys_host_id":[],"servicenow_sysid":[]}}}}}},"403":{"description":"Returned if the user does not have permission to view information about an asset."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/assets":{"post":{"summary":"Import asset list","description":"Imports a list of assets in JSON format. The request cannot exceed 5 MB. Each asset object requires a value for at least one of the following properties: fqdn, ipv4, netbios_name, mac_address.<p>Requires CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-assets-import","tags":["Assets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the asset."},"bios_uuid":{"type":"string","description":"BIOS UUID of the asset."},"ipv4":{"description":"A list of ipv4 addresses for the asset.","type":"array","items":{"type":"string"}},"ipv6":{"description":"A list of ipv6 addresses for the asset.","type":"array","items":{"type":"string"}},"hostname":{"description":"A list of hostnames for the asset.","type":"array","items":{"type":"string"}},"fqdn":{"description":"A list of FQDNs for the asset.","type":"array","items":{"type":"string"}},"ssh_fingerprint":{"type":"string","description":"The SSH fingerprint for the asset."},"mac_address":{"description":"A list of MAC addresses for the asset.","type":"array","items":{"type":"string"}},"netbios_name":{"type":"string","description":"The NetBIOS name for the asset."},"operating_system":{"type":"string","description":"The operating system installed on the asset."},"system_type":{"type":"string","description":"The system architecture (x86) of the asset."}}},"description":"An array of asset objects to import. Each asset object requires a value for at least one of the following properties: fqdn, ipv4, netbios\\_name, mac\\_address. Each asset object may also optionally contain additional properties for each property of was-assets. If any asset fails to be imported, an error message is returned indicating the cause of the failure.","example":"[{\"ipv4\":\"172.204.81.57\",\"operating_system\":\"Windows 7 x64\"}]"},"source":{"type":"string","description":"An identifier for the script used to upload the assets.","example":"Custom Import"}},"required":["assets","source"]}}}},"responses":{"200":{"description":"Returns the import job UUID.","content":{"application/json":{"schema":{"type":"object","properties":{"asset_import_job_uuid":{"type":"string","description":"The asset import job UUID."}}},"examples":{"response":{"value":{"asset_import_job_uuid":"fd7646b5-2c7a-433e-8f2b-f3281b7726ef"}}}}}},"400":{"description":"Returned if the user submitted a bad request."},"403":{"description":"Returned if the user does not have permission to import assets."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/asset-jobs":{"get":{"summary":"List asset import jobs","description":"Lists asset import jobs.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-assets-list-import-jobs","tags":["Assets"],"responses":{"200":{"description":"Returns a list of asset import jobs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the job."},"user_uuid":{"type":"string","description":"The unique ID of the user who started the import job."},"start_time":{"type":"string","description":"The start time of the job."},"end_time":{"type":"string","description":"The end time of the job."},"asset_count":{"type":"integer","description":"The total number of assets uploaded for import."},"imported_asset_count":{"type":"integer","description":"The number of assets successfully imported."},"failed_asset_count":{"type":"integer","description":"The number of assets that failed to import."},"status":{"type":"string","description":"The status of the job."},"error_message":{"type":"string","description":"The description of why a job failed."}}}},"examples":{"response":{"value":{"asset_import_jobs":[{"job_id":"fd7646b5-2c7a-433e-8f2b-f3281b7726ef","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"gabbytest","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480303548,"last_update_time":1544484511492,"end_time":1544484511492,"status":"ERROR","status_message":"Job failed by exceeding time limit"},{"job_id":"15759fd1-3483-4467-b04f-1bff11141c37","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"readmeio","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480429785,"last_update_time":1544484511496,"end_time":1544484511496,"status":"ERROR","status_message":"Job failed by exceeding time limit"}]}}}}}},"403":{"description":"Returned if the user does not have permission to list asset import jobs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/import/asset-jobs/{asset_import_job_uuid}":{"get":{"summary":"Get import job information","description":"Gets information about the specified import job.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-assets-import-job-info","tags":["Assets"],"parameters":[{"description":"The UUID of the asset import job.","required":true,"name":"asset_import_job_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns information about the specified import job.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the job."},"user_uuid":{"type":"string","description":"The unique ID of the user who started the import job."},"start_time":{"type":"string","description":"The start time of the job."},"end_time":{"type":"string","description":"The end time of the job."},"asset_count":{"type":"integer","description":"The total number of assets uploaded for import."},"imported_asset_count":{"type":"integer","description":"The number of assets successfully imported."},"failed_asset_count":{"type":"integer","description":"The number of assets that failed to import."},"status":{"type":"string","description":"The status of the job."},"error_message":{"type":"string","description":"The description of why a job failed."}}},"examples":{"response":{"value":{"job_id":"fd7646b5-2c7a-433e-8f2b-f3281b7726ef","container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","source":"gabbytest","batches":1,"uploaded_assets":0,"failed_assets":0,"start_time":1544480303548,"last_update_time":1544484511492,"end_time":1544484511492,"status":"ERROR","status_message":"Job failed by exceeding time limit"}}}}}},"403":{"description":"Returned if the user does not have permission to list asset import jobs."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/{id}":{"get":{"summary":"Get configuration details","description":"Gets the configuration details for the scan or policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-editor-details","tags":["Editor"],"parameters":[{"description":"The type of object (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}},{"description":"The unique ID of the object.","required":true,"name":"id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the object data.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"user_permissions":{"type":"integer"},"settings":{"type":"object"},"credentials":{"type":"object"},"plugins":{"type":"object"}}},"examples":{"response":{"value":{"credentials":{"data":[{"types":[{"inputs":[{"id":"username","placeholer":"admin","name":"Username","type":"entry","required":true},{"id":"password","name":"Password","type":"password","required":true},{"id":"type","name":"Authentication Type","type":"radio","default":"auto","options":["auto","ntlm"],"optionsLabels":["Basic / Digest","NTLM"]}],"max":1,"name":"HTTP Server Authentication","instances":[],"settings":null},{"inputs":[{"id":"was_auth_method","name":"Authentication method","type":"ui_radio","options":[{"inputs":[{"id":"login_page","name":"Login Page","type":"entry","required":true},{"id":"login_parameters","name":"Login Parameters","type":"entry"},{"id":"login_check","name":"Regex to verify successful auth","type":"entry","required":true},{"id":"login_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"login_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Login Form"},{"inputs":[{"id":"cookies","name":"Cookies","type":"entry"},{"id":"cookie_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"cookie_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Cookie Authentication"},{"inputs":[{"id":"selenium_script","name":"Selenium script (.side)","type":"file","required":true},{"id":"login_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"login_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Selenium Authentication"}],"default":"Login Form","required":true}],"max":1,"name":"Web Application Authentication","instances":[],"settings":null}],"name":"Web Authentication","default_expand":1}]},"is_was":true,"user_permissions":128,"owner":"admin@api.demo","title":"Web App Scan","is_agent":false,"uuid":"09805055-a034-4088-8986-aac5e1c57d5f0d44f09d736969bf","plugins":{"families":{"Injection":{"count":8,"id":8,"status":"enabled"},"File Inclusion":{"count":2,"id":10,"status":"enabled"},"Cross Site Request Forgery":{"count":1,"id":7,"status":"enabled"},"Data Exposure":{"count":7,"id":5,"status":"enabled"},"Cross Site Scripting":{"count":8,"id":6,"status":"enabled"},"Authentication & Session":{"count":4,"id":2,"status":"enabled"},"Web Servers":{"count":13,"id":4,"status":"enabled"},"Code Execution":{"count":5,"id":9,"status":"enabled"},"Component Vulnerability":{"count":502,"id":11,"status":"enabled"},"Web Applications":{"count":42,"id":3,"status":"enabled"}}},"filter_attributes":[],"settings":{"basic":{"inputs":[{"type":"entry","name":"Name","id":"name","default":"test","required":true},{"type":"textarea","name":"Description","id":"description","default":""},{"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","default":9,"options":[{"name":"My Scans","id":19},{"name":"Trash","id":18}]},{"type":"select","id":"scanner_id","name":"Scanner","default":"00000000-0000-0000-0000-00000000000000000000000000001","options":[{"id":"00000000-0000-0000-0000-00000000000000000000000000001","name":"US Cloud Scanner","type":"local","environment_name":null,"linked":true,"status":"on"},{"id":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44","name":"AP Singapore Cloud Scanners","type":"local","environment_name":null,"linked":true,"status":"on"},{"id":"cdf44a84-b547-b66c-d997-920aa1e897cc7165fe2e344196bb","name":"Demo Scanner","type":"local","environment_name":null,"linked":true,"status":"on"},{"id":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef","name":"EU Frankfurt Cloud Scanners","type":"local","environment_name":null,"linked":true,"status":"on"},{"id":"15e29fb5-c378-4803-37f7-67752912247e812e6cf942b4fd2e","name":"US East Cloud Scanners","type":"local","environment_name":null,"linked":true,"status":"on"},{"id":"37b315c1-f31f-cc8e-7e78-585c609fc1d7eba88f8d1e7d24b3","name":"US West Cloud Scanners","type":"local","environment_name":null,"linked":true,"status":"on"}]},{"type":"entry","id":"text_targets","name":"Target","default":"http://172.204.81.57","placeholder":"Example: https://www.tenable.com/","required":true,"regex":"^https?://\\S+$"}],"title":"Basic","groups":[{"title":"Schedule","name":"schedule","enabled":false,"rrules":null,"timezone":null,"starttime":null},{"filter_type":"and","inputs":[{"type":"textarea","name":"Email Recipient(s)","placeholder":"Example: me@example.com, you@example.com"}],"title":"Notifications","name":"email","emails":"","filters":null},{"title":"Permissions","name":"permissions","acls":[{"permissions":0,"owner":null,"display_name":null,"name":null,"id":null,"type":"default"},{"permissions":128,"owner":1,"display_name":"admin@api.demo","name":"admin@api.demo","id":2,"type":"user"}]}],"sections":[]},"assessment":{"inputs":null,"modes":{"id":"assessment_mode","name":"mode","type":"ui_radio","default":"Quick","options":[{"desc":"<ul><li>No assessment will be conducted with this scan.</ul></li>","name":"None"},{"desc":"<ul><li>Elements to Audit<ul><li>Cookies, Headers, Forms, Links</li><li>Parameter Values</li><li>DOM ...","name":"Quick"},{"desc":"<ul><li>Elements to Audit<ul><li>Cookies, Headers, Forms, Links</li><li>Parameter Names and Values</ ...","name":"Extensive"},{"desc":"<ul><li>Choose your own assessment settings.</li></ul>","name":"Custom"}]},"title":"Assessment","groups":[{"inputs":null,"title":"General","name":"general","sections":[{"inputs":[{"type":"checkbox","id":"was_audit_cookies","label":"Audit cookies","default":"yes"},{"type":"checkbox","id":"was_audit_forms","label":"Audit forms","default":"yes"},{"type":"checkbox","id":"was_audit_headers","label":"Audit headers","default":"yes"},{"type":"checkbox","id":"was_audit_links","label":"Audit links","default":"yes"},{"type":"checkbox","id":"was_audit_parameter_names","label":"Audit parameter names","default":"no"},{"type":"checkbox","id":"was_audit_parameter_values","label":"Audit parameter values","default":"yes"},{"type":"checkbox","id":"was_audit_jsons","label":"Audit JSON","default":"no"},{"type":"checkbox","id":"was_audit_xmls","label":"Audit XML","default":"no"},{"type":"checkbox","id":"was_audit_ui_forms","label":"Audit UI Forms","default":"yes"},{"type":"checkbox","id":"was_audit_ui_inputs","label":"Audit UI Inputs","default":"yes"}],"title":"Elements","name":"was_elements"},{"inputs":[{"type":"large-entry","name":"URL for Remote File Inclusion","id":"was_assessment_rfi_remote_url","default":"http://rfi.nessus.org/rfi.txt"}],"title":"Options","name":"was_options"}]}],"sections":[]},"advanced":{"inputs":null,"modes":{"id":"advanced_mode","name":"mode","type":"ui_radio","default":"Custom","options":[{"desc":"<ul><li>Choose your own advanced settings.</li></ul>","name":"Custom"}]},"title":"Advanced","groups":[{"inputs":null,"title":"General","name":"was_general","sections":[{"inputs":[{"type":"medium-entry","name":"Overall Scan max time (HH:MM:SS)","id":"was_timeout","default":"0000","required":true,"regex":"^[0-9]{2,}:[0-5][0-9]:[0-5][0-9]$"}],"title":"Scan Settings","name":"general"},{"inputs":[{"type":"medium-entry","name":"Number of URLs to Crawl and Browse","id":"was_scope_page_limit","default":"10000","required":true,"regex":"^\\d*$"},{"type":"medium-entry","name":"Path Directory Depth","id":"was_scope_directory_depth_limit","default":"10","regex":"^\\d+$"},{"type":"medium-entry","name":"Page DOM Element Depth","id":"was_scope_dom_depth_limit","default":"5","regex":"^\\d+$"},{"type":"medium-entry","name":"Maximum Response Size","id":"was_http_response_max_size","default":"500000","regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Request Redirect Limit","id":"was_http_request_redirect_limit","default":"1","regex":"^\\d+$","required":true}],"title":"Limits","name":"basic_limits"}]},{"inputs":null,"title":"Discovery","name":"was_discovery","sections":[{"inputs":[{"type":"large-entry","name":"User Agent","id":"was_http_user_agent","default":"Nessus WAS/%v","required":true},{"type":"textarea","name":"Custom Headers","id":"was_http_request_headers","default":""}],"title":"Crawl Settings","name":"general"},{"inputs":[{"type":"medium-entry","name":"Screen Width","id":"was_browser_cluster_screen_width","default":"1600","regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Screen Height","id":"was_browser_cluster_screen_height","default":"1200","regex":"^\\d+$","required":true},{"type":"checkbox","id":"was_browser_cluster_ignore_images","label":"Ignore Images","default":"yes","required":true}],"title":"Screen Settings","name":"browser"},{"inputs":[{"type":"medium-entry","id":"was_chrome_script_page_load_wait","name":"Page rendering delay","default":"10000","required":true,"regex":"^\\d+$","hint":"The number of milliseconds to let browser render the page"},{"type":"medium-entry","id":"was_chrome_script_command_wait","name":"Command execution delay","default":"500","required":true,"regex":"^\\d+$","hint":"The number of milliseconds to wait after processing a command before passing to the next one"},{"type":"medium-entry","id":"was_chrome_script_finish_wait","name":"Script completion delay","default":"5000","required":true,"regex":"^\\d+$","hint":"The number of milliseconds to wait once all commands are processed for rendering new contents."}],"title":"Selenium Settings","name":"selenium"}]},{"inputs":null,"title":"Performance","name":"was_performance","sections":[{"inputs":[{"type":"medium-entry","name":"Max number of concurrent HTTP connections","id":"was_http_request_concurrency","default":"10","regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Max number of HTTP requests per second","id":"was_plugins_rate_limiter_requests_per_second","default":"25","regex":"^\\d+$","required":true},{"type":"checkbox","id":"was_plugins_autothrottle","label":"Slow down the scan when network congestion is detected","default":"yes","required":true},{"type":"medium-entry","name":"Network timeout (in seconds)","id":"was_http_request_timeout","default":"5","regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Browser timeout (in seconds)","id":"was_browser_cluster_job_timeout","default":"10","regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Timeout threshold","id":"timeout_abort_threshold","default":"100","regex":"^\\d+$","required":true,"hint":"The number of consecutive timeouts before the scan is aborted (min 100)"}],"title":"Performance Settings","name":"general"}]}],"sections":[]},"scope":{"inputs":null,"title":"Scope","groups":[{"inputs":null,"title":"General Scope","name":"was_scope","sections":[{"inputs":[{"name":"List of URLs","type":"textarea","id":"was_scope_urls","placeholder":"Enter full absolute URLs only","default":""},{"type":"radio-group","id":"was_scope_option","label":"Specify how the scanner handles URL's found during the application crawl","default":"all","options":["all","all","paths","urls"],"optionsLabels":["","Crawl all URLs detected","Limit crawling to specified URLs and child paths","Limit crawling to specified URLs"],"required":true}],"desc":"Specify any URL's that you want to make sure are included in your scan in addition to your target UR ...","title":"Scan Inclusion","name":"scan_inclusion"},{"inputs":[{"name":"Regex for excluded URLs","id":"was_scope_exclude_path_patterns","type":"textarea","placeholder":"Enter patterns to identify URLs to exclude","default":"logout"},{"name":"File extensions to exclude","id":"was_scope_exclude_file_extensions","type":"textarea","placeholder":"Enter extensions separated by commas (css, png)","default":"css, js, png, jpeg, gif, pdf, csv"}],"desc":"Specify any URL's that you want to make sure are excluded from your scan.","title":"Scan Exclusion","name":"scan_exclusion"}]}],"sections":[]},"discovery":{"inputs":null,"modes":{"id":"discovery_mode","name":"mode","type":"ui_radio","default":"Custom","options":[{"desc":"<ul><li>Choose your own discovery settings.</li></ul>","name":"Custom"}]},"title":"Discovery","groups":[{"inputs":null,"title":"Path Discovery","name":"was_path_discovery","sections":[{"inputs":[{"type":"file","name":"Crawl Scripts","id":"was_plugins_selenium_crawl_script"}],"name":"general"}]}],"sections":[]}},"name":"was_scan"}}}}}},"403":{"description":"Returned if the user does not have permission to open the object."},"404":{"description":"Returned if the object does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/templates":{"get":{"summary":"List templates","description":"Lists scan or policy templates, including non-WAS templates.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-editor-list","tags":["Editor"],"parameters":[{"description":"The type of templates to retrieve (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string","enum":["scan","policy"]}}],"responses":{"200":{"description":"Returns the template list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Templates are used to create scans or policies with predefined parameters.","properties":{"unsupported":{"type":"boolean","description":"If true, template is not supported."},"cloud_only":{"type":"boolean","description":"If true, template is only available on the cloud."},"desc":{"type":"string","description":"The description of the template."},"subscription_only":{"type":"boolean","description":"If true, the template is only available for subscribers."},"is_was":{"type":"boolean","description":"If true, the template is for Web Application Scanning."},"title":{"type":"string","description":"The long name of the template."},"is_agent":{"type":"boolean","description":"If true, the template is for agent scans."},"uuid":{"type":"string","description":"The UUID for the template."},"manager_only":{"type":"boolean","description":"If true, can only be used by manager."},"name":{"type":"string","description":"The short name of the template."}}}},"examples":{"response":{"value":{"templates":[{"unsupported":false,"cloud_only":false,"desc":"A scan that checks a web application for vulnerabilities.","order":3,"subscription_only":false,"is_was":true,"title":"Web App Scan","is_agent":false,"uuid":"09805055-a034-4088-8986-aac5e1c57d5f0d44f09d736969bf","manager_only":false,"name":"was_scan"},{"unsupported":false,"cloud_only":false,"desc":"A full system scan suitable for any host.","order":null,"subscription_only":false,"is_was":null,"title":"Basic Network Scan","is_agent":null,"uuid":"731a8e52-3ea6-a291-ec0a-d2ff0619c19d7bd788d6be818b65","manager_only":false,"name":"basic"},{"unsupported":false,"cloud_only":false,"desc":"Audit systems connected via Nessus Agents.","order":null,"subscription_only":false,"is_was":null,"title":"Policy Compliance Auditing","is_agent":true,"uuid":"523c833f-e434-a05f-5a52-0c0c2c160b7cd9c901634c382c2d","manager_only":false,"name":"agent_compliance"}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/policy/{policy_id}/families/{family_id}/plugins/{plugin_id}":{"get":{"summary":"Get plugin details","description":"Gets the details of the plugin associated with the scan or policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-editor-plugin-description","tags":["Editor"],"parameters":[{"description":"The ID of the policy to lookup.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the family to lookup within the policy.","required":true,"name":"family_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the plugin to lookup within the family.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the plugin output.","content":{"application/json":{"schema":{"type":"object","properties":{"plugindescription":{"type":"object"}}},"examples":{"response":{"value":{"plugindescription":{"severity":null,"pluginname":"Ubuntu 10.04 LTS / 10.10 / 11.04 / 11.10 : clamav vulnerability (USN-1258-1)","pluginattributes":{"synopsis":"The remote Ubuntu host is missing a security-related patch.","description":"Stephane Chazelas discovered the bytecode engine of ClamAV improperly handled recursion under certain circumstances. This could allow a remote attacker to craft a file that could cause ClamAV to crash, resulting in a denial of service.\n\nNote that Tenable Network Security has extracted the preceding description block directly from the Ubuntu security advisory. Tenable has attempted to automatically clean and format it as much as possible without introducing additional issues.","risk_information":{"cvss_vector":"CVSS2#AV:N/AC:M/Au:N/C:N/I:N/A:P","risk_factor":"Medium","cvss_base_score":"4.3","cvss_temporal_score":"3.2","cvss_temporal_vector":"CVSS2#E:U/RL:OF/RC:C"},"ref_information":{"ref":[{"name":"bid","values":{"value":["50183"]},"url":"http://www.securityfocus.com/bid/"},{"name":"usn","values":{"value":["1258-1"]},"ext":"/","url":"http://www.ubuntu.com/usn/usn-"},{"name":"cve","values":{"value":["CVE-2011-3627"]},"url":"http://web.nvd.nist.gov/view/vuln/detail?vulnId="}]},"plugin_name":"Ubuntu 10.04 LTS / 10.10 / 11.04 / 11.10 : clamav vulnerability (USN-1258-1)","see_also":["https://usn.ubuntu.com/1258-1/"],"fname":"ubuntu_USN-1258-1.nasl","usn":"1258-1","plugin_information":{"plugin_version":"1.8","plugin_id":56777,"plugin_type":"local","plugin_publication_date":"2011/11/11","plugin_family":"Ubuntu Local Security Checks","plugin_modification_date":"2018/12/01"},"solution":"Update the affected libclamav6 package.","vuln_information":{"cpe":"cpe:/o:canonical:ubuntu_linux:10.04:-:lts\ncpe:/o:canonical:ubuntu_linux:10.10\ncpe:/o:canonical:ubuntu_linux:11.04\ncpe:/o:canonical:ubuntu_linux:11.10","exploitability_ease":"No known exploits are available","exploit_available":"false","patch_publication_date":"2011/11/10"}},"pluginfamily":"Ubuntu Local Security Checks","pluginid":"56777"}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/editor/{type}/templates/{template_uuid}":{"get":{"summary":"Get template details","description":"Gets details for the given template.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-editor-template-details","tags":["Editor"],"parameters":[{"description":"The type of template to retrieve (scan or policy).","required":true,"name":"type","in":"path","schema":{"type":"string"}},{"description":"The UUID for the template.","required":true,"name":"template_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the template details.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"name":{"type":"string"},"is_agent":{"type":"boolean"},"settings":{"type":"object"},"credentials":{"type":"object"},"plugins":{"type":"object"}}},"examples":{"response":{"value":{"credentials":{"data":[{"types":[{"inputs":[{"id":"username","placeholer":"admin","name":"Username","type":"entry","required":true},{"id":"password","name":"Password","type":"password","required":true},{"id":"type","name":"Authentication Type","type":"radio","default":"auto","options":["auto","ntlm"],"optionsLabels":["Basic / Digest","NTLM"]}],"max":1,"name":"HTTP Server Authentication","instances":[],"settings":null},{"inputs":[{"id":"was_auth_method","name":"Authentication method","type":"ui_radio","options":[{"inputs":[{"id":"login_page","name":"Login Page","type":"entry","required":true},{"id":"login_parameters","name":"Login Parameters","type":"entry"},{"id":"login_check","name":"Regex to verify successful auth","type":"entry","required":true},{"id":"login_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"login_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Login Form"},{"inputs":[{"id":"cookies","name":"Cookies","type":"entry"},{"id":"cookie_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"cookie_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Cookie Authentication"},{"inputs":[{"id":"selenium_script","name":"Selenium script (.side)","type":"file","required":true},{"id":"login_check_url","name":"Page to verify active session","type":"entry","required":true},{"id":"login_check_pattern","name":"Regex to verify active session","type":"entry","required":true}],"name":"Selenium Authentication"}],"default":"Login Form","required":true}],"max":1,"name":"Web Application Authentication","instances":[],"settings":null}],"name":"Web Authentication","default_expand":1}]},"is_was":true,"user_permissions":128,"owner":"api@api.demo","title":"Web App Overview","is_agent":false,"uuid":"58323412-d521-9482-2224-bdf5e2d65e6a4c67d33d4322677f","plugins":{"families":{"Web Applications":{"count":15,"id":3,"status":"enabled"},"Data Exposure":{"count":4,"id":5,"status":"enabled"},"Authentication & Session":{"count":2,"id":2,"status":"enabled"},"Web Servers":{"count":5,"id":4,"status":"enabled"}}},"filter_attributes":[],"settings":{"basic":{"inputs":[{"type":"entry","name":"Name","id":"name","required":true},{"type":"textarea","name":"Description","id":"description"}],"title":"Basic","groups":[{"title":"Permissions","name":"permissions","acls":null}],"sections":[]},"advanced":{"inputs":null,"modes":{"id":"advanced_mode","name":"mode","type":"ui_radio","default":"Custom","options":[{"desc":"<ul><li>Choose your own advanced settings.</li></ul>","name":"Custom"}]},"title":"Advanced","groups":[{"inputs":null,"title":"General","name":"was_general","sections":[{"inputs":[{"type":"medium-entry","name":"Overall Scan max time (HH:MM:SS)","id":"was_timeout","default":"08:000","required":true,"regex":"^[0-9]{2,}:[0-5][0-9]:[0-5][0-9]$"}],"title":"Scan Settings","name":"general"},{"inputs":[{"type":"medium-entry","name":"Number of URLs to Crawl and Browse","id":"was_scope_page_limit","default":10000,"required":true,"regex":"^\\d*$"},{"type":"medium-entry","name":"Path Directory Depth","id":"was_scope_directory_depth_limit","default":10,"regex":"^\\d+$"},{"type":"medium-entry","name":"Page DOM Element Depth","id":"was_scope_dom_depth_limit","default":5,"regex":"^\\d+$"},{"type":"medium-entry","name":"Maximum Response Size","id":"was_http_response_max_size","default":500000,"regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Request Redirect Limit","id":"was_http_request_redirect_limit","default":1,"regex":"^\\d+$","required":true}],"title":"Limits","name":"basic_limits"}]},{"inputs":null,"title":"Discovery","name":"was_discovery","sections":[{"inputs":[{"type":"large-entry","name":"User Agent","id":"was_http_user_agent","default":"Nessus WAS/%v","required":true},{"type":"textarea","name":"Custom Headers","id":"was_http_request_headers","default":""}],"title":"Crawl Settings","name":"general"},{"inputs":[{"type":"medium-entry","name":"Screen Width","id":"was_browser_cluster_screen_width","default":1600,"regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Screen Height","id":"was_browser_cluster_screen_height","default":1200,"regex":"^\\d+$","required":true},{"type":"checkbox","id":"was_browser_cluster_ignore_images","label":"Ignore Images","default":"yes","required":true}],"title":"Screen Settings","name":"browser"},{"inputs":[{"type":"medium-entry","id":"was_chrome_script_page_load_wait","name":"Page rendering delay","default":10000,"required":true,"regex":"^\\d+$","hint":"The number of milliseconds to let browser render the page"},{"type":"medium-entry","id":"was_chrome_script_command_wait","name":"Command execution delay","default":500,"required":true,"regex":"^\\d+$","hint":"The number of milliseconds to wait after processing a command before passing to the next one"},{"type":"medium-entry","id":"was_chrome_script_finish_wait","name":"Script completion delay","default":5000,"required":true,"regex":"^\\d+$","hint":"The number of milliseconds to wait once all commands are processed for rendering new contents."}],"title":"Selenium Settings","name":"selenium"}]},{"inputs":null,"title":"Performance","name":"was_performance","sections":[{"inputs":[{"type":"medium-entry","name":"Max number of concurrent HTTP connections","id":"was_http_request_concurrency","default":10,"regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Max number of HTTP requests per second","id":"was_plugins_rate_limiter_requests_per_second","default":25,"regex":"^\\d+$","required":true},{"type":"checkbox","id":"was_plugins_autothrottle","label":"Slow down the scan when network congestion is detected","default":"yes","required":true},{"type":"medium-entry","name":"Network timeout (in seconds)","id":"was_http_request_timeout","default":5,"regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Browser timeout (in seconds)","id":"was_browser_cluster_job_timeout","default":10,"regex":"^\\d+$","required":true},{"type":"medium-entry","name":"Timeout threshold","id":"timeout_abort_threshold","default":100,"regex":"^\\d+$","required":true,"hint":"The number of consecutive timeouts before the scan is aborted (min 100)"}],"title":"Performance Settings","name":"general"}]}],"sections":[]},"scope":{"inputs":null,"title":"Scope","groups":[{"inputs":null,"title":"General Scope","name":"was_scope","sections":[{"inputs":[{"name":"List of URLs","type":"textarea","id":"was_scope_urls","placeholder":"Enter full absolute URLs only","default":""},{"type":"radio-group","id":"was_scope_option","label":"Specify how the scanner handles URL's found during the application crawl","default":"all","options":["all","all","paths","urls"],"optionsLabels":["","Crawl all URLs detected","Limit crawling to specified URLs and child paths","Limit crawling to specified URLs"],"required":true}],"desc":"Specify any URL's that you want to make sure are included in your scan in addition to your target URL.","title":"Scan Inclusion","name":"scan_inclusion"},{"inputs":[{"name":"Regex for excluded URLs","id":"was_scope_exclude_path_patterns","type":"textarea","placeholder":"Enter patterns to identify URLs to exclude","default":"logout"},{"name":"File extensions to exclude","id":"was_scope_exclude_file_extensions","type":"textarea","placeholder":"Enter extensions separated by commas (css, png)","default":"css, png, jpeg, gif, pdf, csv"}],"desc":"Specify any URL's that you want to make sure are excluded from your scan.","title":"Scan Exclusion","name":"scan_exclusion"}]}],"sections":[]},"discovery":{"inputs":null,"modes":{"id":"discovery_mode","name":"mode","type":"ui_radio","default":"Custom","options":[{"desc":"<ul><li>Choose your own discovery settings.</li></ul>","name":"Custom"}]},"title":"Discovery","groups":[{"inputs":null,"title":"Path Discovery","name":"was_path_discovery","sections":[{"inputs":[{"type":"file","name":"Crawl Scripts","id":"was_plugins_selenium_crawl_script"}],"name":"general"}]}],"sections":[]}},"name":"was_overview"}}}}}},"403":{"description":"Returned if the user does not have permission to open the template."},"404":{"description":"Returned if the template does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/folders":{"post":{"summary":"Create new folder","description":"Creates a new folder for the current user.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-folders-create","tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"responses":{"200":{"description":"Returns the new folder ID.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"id":50}}}}}},"400":{"description":"Returned if the folder name is invalid."},"403":{"description":"Returned if the user does not have permission to create a folder."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to create the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List scan folders","description":"Lists the current user's scan folders.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-folders-list","tags":["Folders"],"responses":{"200":{"description":"Returns the folder list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the folder."},"name":{"type":"string","description":"The name of the folder."},"type":{"type":"string","description":"The type of the folder (main, trash, custom)."},"default_tag":{"type":"integer","description":"Whether or not the folder is the default (1 or 0)."},"custom":{"type":"integer","description":"The custom status of the folder (1 or 0)."},"unread_count":{"type":"integer","description":"The number of unread scans in the folder."}}}},"examples":{"response":{"value":{"folders":[{"unread_count":0,"custom":0,"default_tag":0,"type":"trash","name":"Trash","id":18},{"unread_count":5,"custom":0,"default_tag":1,"type":"main","name":"My Scans","id":19},{"unread_count":0,"custom":1,"default_tag":0,"type":"custom","name":"fphaghh","id":34}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/folders/{folder_id}":{"put":{"summary":"Rename folder","description":"Renames a folder for the current user.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-folders-edit","tags":["Folders"],"parameters":[{"description":"The ID of the folder to edit.","required":true,"name":"folder_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if the folder has been successfully renamed.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if the user tried to rename a system folder."},"404":{"description":"Returned if the folder does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to rename the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete folder","description":"Deletes a folder.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-folders-delete","tags":["Folders"],"parameters":[{"description":"The ID of the folder to delete.","required":true,"name":"folder_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the folder has been successfully deleted.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if the user tried to delete a system folder."},"404":{"description":"Returned if the folder does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to delete the folder.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups":{"post":{"summary":"Create scanner group","description":"Creates a new scanner group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-create","tags":["Scanner Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name for the new scanner group."},"type":{"type":"string","description":"The type of scanner group.","enum":["load_balancing"]}},"required":["name","type"]}}}},"responses":{"200":{"description":"Returned if the scanner group has been successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the scacner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."},"scanner_uuid":{"type":"string","description":"The UUID of the scanner group."},"owner_name":{"type":"string","description":"The name for the owner of the scanner group."}}},"examples":{"response":{"value":{"creation_date":1545331154,"last_modification_date":1545331154,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"scan_count":0,"uuid":"f00b532a-cbcd-4f9e-9292-9174083332df","type":"load_balancing","name":"Example Group","id":102825,"owner_name":"system"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to create the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List scanner groups","description":"Lists scanner groups within the current container.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-list","tags":["Scanner Groups"],"responses":{"200":{"description":"Returns the scanner group list.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the scacner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."},"scanner_uuid":{"type":"string","description":"The UUID of the scanner group."},"owner_name":{"type":"string","description":"The name for the owner of the scanner group."}}},"examples":{"response":{"value":{"scanner_pools":[{"creation_date":1545326169,"last_modification_date":1545345793,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":1,"uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","type":"load_balancing","name":"New Group Name","id":102823,"scanner_id":144057,"scanner_uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","owner_name":"system"},{"creation_date":1545326198,"last_modification_date":1545345902,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":1,"uuid":"80ac7fcd-429b-4858-9d85-207577f6a35c","type":"load_balancing","name":"Group New Name","id":102824,"scanner_id":144058,"scanner_uuid":"80ac7fcd-429b-4858-9d85-207577f6a35c","owner_name":"system"},{"creation_date":1545331154,"last_modification_date":1545331154,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"scanner_count":2,"uuid":"f00b532a-cbcd-4f9e-9292-9174083332df","type":"load_balancing","name":"test1","id":102825,"scanner_id":144059,"scanner_uuid":"f00b532a-cbcd-4f9e-9292-9174083332df","owner_name":"system"}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}/scanners/{scanner_id}":{"post":{"summary":"Add scanner to scanner group","description":"Adds a scanner to the scanner group.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-add-scanner","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner to add to the scanner group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the scanner has been successfully added to the scanner group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"To do":"Add response sample here"}}}}}},"400":{"description":"Returned if an attempt is made to add a scanner group to another scanner group."},"409":{"description":"Returned if you attempt to add a scanner to a scanner group that the scanner is already a member of.","content":{"text/html":{"examples":{"response":{"value":{"error":"Scanner 00000000-0000-0000-0000-00000000000000000000000000001 already exists in group f00b532a-cbcd-4f9e-9292-9174083332df"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to add the scanner to the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Remove scanner from scanner group","description":"Remove a scanner from the scanner group.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-delete-scanner","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scanner to remove from the scanner group.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the scanner has been successfully removed from the scanner group.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to remove the scanner from the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}/scanners":{"get":{"summary":"List scanners within scanner group","description":"Lists scanners associated with the scanner group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-list-scanners","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the list of scanners in the group.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner in Unix time."},"group":{"type":"boolean","description":"True if the scanner is in a group; false, otherwise."},"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"last_connect":{"type":"integer","description":"The last_connect time in Unix time."},"last_modification_date":{"type":"integer","description":"The last_modification_date in Unix time."},"linked":{"type":"integer","description":"1 if the scanner is linked; 0, otherwise."},"name":{"type":"string","description":"The user-defined name of the scanner."},"type":{"type":"string","description":"The type of scanner (managed_webapp)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"A alphanumeric sequence of characters used when linking a scanner to Tenable.io."}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1543416914,"group":true,"id":141484,"key":"70d1969c3a1a14697ad51f27f1ee4afe48ef535051d90f5481e32fd78005f05a","last_connect":null,"last_modification_date":1543416914,"license":null,"linked":1,"name":"US Cloud Scanner","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"source":"service","status":"on","timestamp":1543416914,"type":"local","uuid":"00000000-0000-0000-0000-00000000000000000000000000001"}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanner-groups/{group_id}":{"get":{"summary":"List scanner group details","description":"Retruns details for the given scanner group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-details","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner group details.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner group in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scanner group in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scanner group."},"owner":{"type":"string","description":"The username of the owner of the scanner group."},"owner_uuid":{"type":"string","description":"The UUID of the owner of the scacner group."},"default_permissions":{"type":"integer","description":"The access permissions for the Default group."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scanner group."},"shared":{"type":"integer","description":"The shared status of the scanner group."},"scan_count":{"type":"integer","description":"The number of scans currently tasked to the scanner group."},"scanner_count":{"type":"string","description":"The number of scanners associated with this scanner group."},"uuid":{"type":"string","description":"The UUID of the scanner group."},"type":{"type":"string","description":"The type of scanner group. This is set to \"load_balancing\" by default."},"name":{"type":"string","description":"The name of the scanner group."},"id":{"type":"integer","description":"The unique ID of the scanner group."},"scanner_id":{"type":"integer","description":"The unique scanner ID of the scanner group."},"scanner_uuid":{"type":"string","description":"The UUID of the scanner group."},"owner_name":{"type":"string","description":"The name for the owner of the scanner group."}}},"examples":{"response":{"value":{"creation_date":1545326169,"last_modification_date":1545326169,"owner_id":1,"owner":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","default_permissions":16,"user_permissions":128,"shared":1,"scan_count":0,"uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","type":"load_balancing","name":"New Scanner Group","network_name":"Default","id":102823,"scanner_id":144057,"scanner_uuid":"9b7b3d08-cc43-4e67-adc6-41b706c0b680","owner_name":"system"}}}}}},"403":{"description":"Returned if user does not have permission to view the scanner group."},"404":{"description":"Returned if the scanner group does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update scanner group","description":"Updates a scanner group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-edit","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name for the scanner group."}},"required":["name"]}}}},"responses":{"200":{"description":"Returned if the scanner group has been successfully updated.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","created":1545326198354,"modified":1545345902579,"container_uuid":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","uuid":"80ac7fcd-429b-4858-9d85-207577f6a35c","id":102824,"name":"Group New Name","type":"load_balancing","distributed":false,"default_permissions":16,"network_name":"Default","shared":1,"user_permissions":128,"created_in_seconds":1545326198,"modified_in_seconds":1545345902}}}}}},"404":{"description":"Returned if the scanner group does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to update the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete a scanner group","description":"Deletes a scanner group.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanner-groups-delete","tags":["Scanner Groups"],"parameters":[{"description":"The ID of the scanner group.","required":true,"name":"group_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the scanner group has been successfully deleted.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the scanner group does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to delete the scanner group.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/policies":{"post":{"summary":"Create policy","description":"Creates a policy.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-create","tags":["Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the editor template to use.","example":"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40"},"settings":{"type":"object","properties":{}}},"required":["uuid"]}}}},"responses":{"200":{"description":"Returned if Tenable.io saved the policy successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"policy_id":{"type":"integer"},"policy_name":{"type":"string"}}},"examples":{"response":{"value":{"policy_id":"integer","policy_name":"string"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an error while saving the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List policies","description":"Returns a list of policies, including non-WAS policies.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-list","tags":["Policies"],"responses":{"200":{"description":"Returns the policy list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the policy."},"template_uuid":{"type":"string","description":"The UUID for the template the policy uses."},"name":{"type":"string","description":"The name of the policy."},"description":{"type":"string","description":"The description of the policy."},"owner_id":{"type":"string","description":"The unique ID of the owner of the policy."},"owner":{"type":"string","description":"The username for the owner of the policy."},"shared":{"type":"integer","description":"The shared status of the policy."},"user_permissions":{"type":"integer","description":"The sharing permissions for the policy."},"creation_date":{"type":"integer","description":"The creation date of the policy in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the policy in Unix time."},"visibility":{"type":"integer","description":"The visibility of the target (private or shared)."},"no_target":{"type":"boolean","description":"If `true`, the policy does not use targets."},"timeout_abort_threshold":{"type":"integer","description":"The number of consecutive timeouts before the scan aborts (minimum 100)."},"was_browser_cluster_ignore_images":{"type":"string","description":"Specifies whether images on web pages should be crawled or ignored by the virtual browser instance embedded into the scanner. Possible values are `yes` or `no`."},"was_browser_cluster_job_timeout":{"type":"integer","description":"The time that the scanner waits for a response from a browser, unless otherwise specified within a plugin. If you are scanning over a slow connection, you may wish to set this to a higher number of seconds."},"was_browser_cluster_screen_height":{"type":"integer","description":"The screen height, in pixels, of the virtual browser instance embedded into the scanner."},"was_browser_cluster_screen_width":{"type":"integer","description":"The screen width, in pixels, of the virtual browser instance embedded into the scanner."},"was_chrome_script_command_wait":{"type":"integer","description":"When running Selenium scripts for authentication and crawling, the number of milliseconds to wait after processing a command before passing to the next one."},"was_chrome_script_finish_wait":{"type":"integer","description":"When running Selenium scripts for authentication and crawling, the number of milliseconds to wait once all commands are processed for rendering new contents."},"was_chrome_script_page_load_wait":{"type":"integer","description":"When running Selenium scripts for authentication and crawling, the number of milliseconds to let the browser render the page."},"was_http_request_concurrency":{"type":"integer","description":"The maximum number of established HTTP sessions for a single host."},"was_http_request_headers":{"type":"string","description":"A list of custom headers injected into each HTTP request."},"was_http_request_redirect_limit":{"type":"integer","description":"The number of redirects the scan follows before it stops trying to crawl the page."},"was_http_request_timeout":{"type":"integer","description":"The time that the scanner waits for a response from a host, unless otherwise specified within a plugin. If you are scanning over a slow connection, you may wish to set this to a higher number of seconds."},"was_http_response_max_size":{"type":"integer","description":"The maximum load size of a page in order to be audited. If the scanner crawls a URL and the response exceeds the limit, then it is not audited and no vulnerability assessment is performed."},"was_http_user_agent":{"type":"string","description":"The user-agent header used by the scanner when sending an HTTP request. For example, `Nessus WAS/%v` where %v is the version of the scan engine."},"was_plugins_autothrottle":{"type":"string","description":"The plugins autothrottle setting (yes or no)."},"was_plugins_rate_limiter_requests_per_second":{"type":"integer","description":"The maximum number of HTTP requests for the entire scan for a single host."},"was_plugins_selenium_crawl_script":{"type":"string","description":"The name of the file containing Selenium scripts that Web Application Scanning uploads and uses to crawl during the scan. For more information, see <a href=\"https://docs.tenable.com/webapplicationscanning/Content/WebApplicationScanning/WebAppAuthentication.htm\">Configure Selenium Authentication</a> in the Tenable.io Web Application Scanning User Guide."},"was_scope_directory_depth_limit":{"type":"integer","description":"The maximum number of sub-directories the scanner crawls. For example, http://www.tenable.com/products/tenable-io has two sub-directories."},"was_scope_dom_depth_limit":{"type":"integer","description":"The maximum depth of HTML nested elements the scanner crawls."},"was_scope_exclude_file_extensions":{"type":"string","description":"A list of file types excluded from the scan. Possible values are: css, js, png, jpeg, gif, pdf, csv."},"was_scope_exclude_path_patterns":{"type":"string","description":"A regex specifying URLs excluded from the scan."},"was_scope_option":{"type":"string","description":"Specifies how the scanner handles URLs found during the application crawl. Possible values are:\n - all—Crawl all URLs detected.\n - urls—Limit crawling to specified URLs.\n - paths—Limit crawling to specified URLs and child paths."},"was_scope_page_limit":{"type":"integer","description":"The maximum number of URLs the scanner attempts to crawl and therefore audit."},"was_scope_urls":{"type":"string","description":"The list of URLs that are scanned."},"was_timeout":{"type":"string","description":"The maximum duration the scan runs before it stops automatically. This value uses the format, HH:MM:SS."}}}},"examples":{"response":{"value":{"policies":[{"no_target":"false","template_uuid":"ad629e16-03b6-8c1d-cef6-ef8c9dd3c658d24bd260ef5f9e66","description":"An example policy.","name":"Test Policy 1","owner":"api@api.demo","visibility":"shared","shared":1,"user_permissions":128,"last_modification_date":1545938690,"creation_date":1545938690,"owner_id":3,"id":43},{"no_target":"false","template_uuid":"09805055-a034-4088-8986-aac5e1c57d5f0d44f09d736969bf","description":"Policy for web app scans.","name":"Web App Scan Policy","owner":"api@api.demo","visibility":"private","shared":0,"user_permissions":128,"last_modification_date":1545947139,"creation_date":1545947139,"owner_id":3,"id":51}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the policy list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}":{"get":{"summary":"List policy details","description":"Returns the details for the given policy.<p>Requires CAN USE [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-details","tags":["Policies"],"parameters":[{"description":"The ID of the policy to retrieve.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy details. This response can be edited and passed directly to the [PUT /policies/{policy_id}](/reference#was-policies-configure) endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string"},"credentials":{"type":"object"},"plugins":{"type":"object"},"settings":{"type":"object"}}},"examples":{"response":{"value":{"plugins":{"Injection":{"status":"enabled"},"File Inclusion":{"status":"enabled"},"Cross Site Request Forgery":{"status":"enabled"},"Data Exposure":{"status":"enabled"},"Cross Site Scripting":{"status":"enabled"},"Authentication & Session":{"status":"enabled"},"Web Servers":{"status":"enabled"},"Code Execution":{"status":"enabled"},"Component Vulnerability":{"status":"enabled"},"Web Applications":{"status":"enabled"}},"settings":{"was_chrome_script_command_wait":"500","was_scope_urls":"","description":"Policy for web app scans.","was_http_request_redirect_limit":"1","was_browser_cluster_screen_height":"1200","was_scope_dom_depth_limit":"5","was_http_user_agent":"Nessus WAS/%v","was_plugins_rate_limiter_requests_per_second":"25","was_scope_exclude_path_patterns":"logout","was_http_response_max_size":"500000","was_plugins_autothrottle":"yes","was_http_request_timeout":"5","was_plugins_selenium_crawl_script":"","was_http_request_concurrency":"10","assessment_mode":"Quick","was_timeout":"08:00:00","was_http_request_headers":"","was_scope_page_limit":"10000","was_browser_cluster_job_timeout":"10","was_scope_exclude_file_extensions":"css, png, jpeg, gif, pdf, csv","was_chrome_script_finish_wait":"5000","was_scope_directory_depth_limit":"10","was_chrome_script_page_load_wait":"10000","timeout_abort_threshold":"100","was_scope_option":"all","was_browser_cluster_ignore_images":"yes","was_browser_cluster_screen_width":"1600","name":"Web App Scan Policy"},"uuid":"09805055-a034-4088-8986-aac5e1c57d5f0d44f09d736969bf"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"put":{"summary":"Update policy","description":"Updates the parameters of a policy.<p>Requires CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-configure","tags":["Policies"],"parameters":[{"description":"The ID of the policy to change.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io changed the policy configuration.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the policy does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io encountered an error while saving the configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete policy","description":"Deletes a policy.<p>Requires CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-delete","tags":["Policies"],"parameters":[{"description":"The ID of the policy to delete.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io deleted the policy.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if the user does not have permission to delete the policy."},"404":{"description":"Returned if the policy does not exist."},"405":{"description":"Returned if the policy is in use by a scan."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}/copy":{"post":{"summary":"Copy policy","description":"Copies a policy.<p>Requires CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-copy","tags":["Policies"],"parameters":[{"description":"The ID of the policy to copy.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy object with the ID and name properties set.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{"name":"Copy of Web App Scan Policy","id":52}}}}}},"403":{"description":"Returned if the user does not have permission to copy the policy."},"404":{"description":"Returned if the policy does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io failed to copy the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/policies/import":{"post":{"summary":"Import policy","description":"Imports an existing policy uploaded using POST /file/upload (.nessus format only).<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-import","tags":["Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The name of the file to import as provided by the response from [file: upload](/reference#file-upload)."}},"required":["file"]}}}},"responses":{"200":{"description":"Returns the policy object.","content":{"application/json":{"schema":{"type":"object","properties":{"private":{"type":"integer"},"no_target":{"type":"string"},"template_uuid":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"shared":{"type":"integer"},"user_permissions":{"type":"integer"},"last_modification_date":{"type":"integer"},"creation_date":{"type":"integer"},"owner_id":{"type":"integer"},"id":{"type":"integer"}}},"examples":{"response":{"value":{"private":"integer","no_target":"string","template_uuid":"string","description":"string","name":"string","owner":"string","shared":"integer","user_permissions":"integer","last_modification_date":"integer","creation_date":"integer","owner_id":"integer","id":"integer"}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to import the policy.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/policies/{policy_id}/export":{"get":{"summary":"Export policy","description":"Exports the given policy.<p>Requires CAN EDIT [32] policy permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-policies-export","tags":["Policies"],"parameters":[{"description":"The ID of the policy to export.","required":true,"name":"policy_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the policy in nessus (XML) format.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if the user does not have permission to export the policy."},"404":{"description":"Returned if the policy does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners":{"get":{"summary":"List scanners","description":"Returns the scanner list.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-list","tags":["Scanners"],"responses":{"200":{"description":"Returns the scanner list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner in Unix time."},"group":{"type":"boolean","description":"True if the scanner is in a group; false, otherwise."},"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"last_connect":{"type":"integer","description":"The last_connect time in Unix time."},"last_modification_date":{"type":"integer","description":"The last_modification_date in Unix time."},"linked":{"type":"integer","description":"1 if the scanner is linked; 0, otherwise."},"name":{"type":"string","description":"The user-defined name of the scanner."},"type":{"type":"string","description":"The type of scanner (managed_webapp)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"A alphanumeric sequence of characters used when linking a scanner to Tenable.io."}}}},"examples":{"response":{"value":{"scanners":[{"creation_date":1543416914,"group":true,"id":141482,"key":"83520d0f4da8265cb52f7b558a3319ecb36d4b0ea490d4f9ec4ca9f2e1eee8b9","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"AP Singapore Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44"},{"creation_date":1543416914,"group":true,"id":141483,"key":"e3eeefeacca0d998c466af126549d68ef0f4e0d0ba3ab04a6e59a1d8a8a57079","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"EU Frankfurt Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"06ab826a-301d-7829-d2c4-37f400c0f949ea8cce60f523eeef"},{"creation_date":1543416914,"group":true,"id":141484,"key":"70d1969c3a1a14697ad51f27f1ee4afe48ef535051d90f5481e32fd78005f05a","last_connect":null,"last_modification_date":1543416914,"license":{"agents":512,"ips":1024,"scanners":2,"users":10,"enterprise_pause":false,"expiration_date":1551160800,"evaluation":false,"apps":{"was":{"mode":"eval","expiration_date":1549299101}},"scanners_used":0,"agents_used":0},"linked":1,"name":"US Cloud Scanner","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"00000000-0000-0000-0000-00000000000000000000000000001"}]}}}}}},"403":{"description":"Returned if the user does not have permission to view the list."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/key":{"get":{"summary":"Get scanner key","description":"Gets the key of the requested scanner.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-get-scanner-key","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner key.","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string"}}},"examples":{"response":{"value":{"key":"83520d0f4da8265cb52f7b558a3319ecb36d4b0ea490d4f9ec4ca9f2e1eee8b9"}}}}}},"403":{"description":"Returned if user does not have permission to view scanner data."},"404":{"description":"Returned if the scanner does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}":{"get":{"summary":"Get scanner details","description":"Gets details for the given scanner.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-details","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scanner details.","content":{"application/json":{"schema":{"type":"object","properties":{"creation_date":{"type":"integer","description":"The creation date for the scanner in Unix time."},"group":{"type":"boolean","description":"True if the scanner is in a group; false, otherwise."},"id":{"type":"integer","description":"The unique ID of the scanner."},"uuid":{"type":"string","description":"The UUID of the scanner."},"last_connect":{"type":"integer","description":"The last_connect time in Unix time."},"last_modification_date":{"type":"integer","description":"The last_modification_date in Unix time."},"linked":{"type":"integer","description":"1 if the scanner is linked; 0, otherwise."},"name":{"type":"string","description":"The user-defined name of the scanner."},"type":{"type":"string","description":"The type of scanner (managed_webapp)."},"status":{"type":"string","description":"The status of the scanner (on or off)."},"scan_count":{"type":"integer","description":"The current number of running scans on the scanner."},"engine_version":{"type":"string","description":"The version of the scanner."},"owner":{"type":"string","description":"The owner of the scanner."},"key":{"type":"string","description":"A alphanumeric sequence of characters used when linking a scanner to Tenable.io."}}},"examples":{"response":{"value":{"creation_date":1543416914,"group":true,"id":141482,"key":"83520d0f4da8265cb52f7b558a3319ecb36d4b0ea490d4f9ec4ca9f2e1eee8b9","last_connect":null,"last_modification_date":1543416914,"license":null,"linked":1,"name":"AP Singapore Cloud Scanners","network_name":"Default","num_scans":0,"owner":"system","owner_id":1,"owner_name":"system","owner_uuid":"fe2e8b99-791a-429a-ab84-4226e62306ff","pool":true,"scan_count":0,"shared":1,"source":"service","status":"on","timestamp":1543416914,"type":"local","user_permissions":64,"uuid":"1b895828-62a9-5084-8bc5-d4864a927fb10523d1e84e3fef44"}}}}}},"403":{"description":"Returned if user does not have permission to view the scanner."},"404":{"description":"Returned if the scanner does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete scanner","description":"Deletes and unlinks a scanner from Tenable.io.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-delete","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the server deleted/unlinked the scanner.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if an attempt is made to delete the local scanner."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the server failed to delete the scanner.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/scans":{"get":{"summary":"List running scans","description":"Lists scans running on the requested scanner.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-get-scans","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the list of scans running on the requested scanner.","content":{"application/json":{"schema":{"type":"object","properties":{"scanner_uuid":{"type":"string","description":"The UUID of the scanner the scan belongs to."},"name":{"type":"string","description":"The name of the scan."},"status":{"type":"string","description":"Scan status. Can be: pending, processing, stopping, pausing, paused, resuming, or running."},"id":{"type":"string","description":"The scan UUID."},"scan_id":{"type":"integer","description":"The ID of the scan."},"user":{"type":"string","description":"The username of the scan owner."},"last_modification_date":{"type":"integer","description":"The last time the scan was modified in Unix time."},"start_time":{"type":"integer","description":"The date and time when the scan was started."},"remote":{"type":"boolean","description":"True if the scan is running remotely; false, otherwise."}}},"examples":{"response":{"value":{"scans":[{"scan_id":53,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","name":"Web App Scan","status":"running","id":"0224cbf3-144b-415a-96e5-526afdbd6bec","user":"API Demo User","user_uuid":"394a4be9-782d-406a-9d0a-695188260f0b","last_modification_date":1545948401,"start_time":1545948381}]}}}}}},"403":{"description":"Returned if user does not have permission to view scanner data."},"404":{"description":"Returned if the scanner does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scanners/{scanner_id}/link":{"put":{"summary":"Toggle scanner link state","description":"Enables or disables the link state of the scanner identified by `scanner_id`.<p>Requires ADMINISTRATOR [64] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scanners-toggle-link-state","tags":["Scanners"],"parameters":[{"description":"The ID of the scanner.","required":true,"name":"scanner_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"integer","description":"Pass 1 enable the link. Pass 0 to disable.","format":"int32"}},"required":["link"]}}}},"responses":{"200":{"description":"Returned if updating the scanner was successful.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"403":{"description":"Returned if the scanner is a cloud scanner and the user doesnt have permission to edit it."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans":{"post":{"summary":"Create scan","description":"Creates a scan.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-create","tags":["Scans"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the editor template to use.","example":"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40"},"settings":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"description":{"type":"string","description":"The description of the scan."},"policy_id":{"type":"integer","description":"The unique ID of the policy to use.","format":"int32"},"folder_id":{"type":"integer","description":"The unique ID of the destination folder for the scan.","format":"int32"},"scanner_id":{"type":"integer","description":"The unique ID of the scanner to use.","example":"1","format":"int32"},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"launch":{"type":"string","description":"When to launch the scan. Valid values are: ON\\_DEMAND, DAILY, WEEKLY, MONTHLY, YEARLY.","enum":["ON_DEMAND","DAILY","WEEKLY","MONTHLY","YEARLY"]},"starttime":{"type":"string","description":"The starting time and date for the scan in the following format: YYYYMMDDTHHMMSS.","example":"20140826T133000"},"rrules":{"type":"string","description":"Expects a string of three values separated by semi-colons. The frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`","example":"FREQ=DAILY;INTERVAL=1"},"timezone":{"type":"string","description":"The timezone for the scan schedule.","example":"America/New_York"},"text_targets":{"type":"string","description":"A single URL to scan.","example":"localhost"},"emails":{"type":"string","description":"A comma-separated list of accounts who will receive the email summary report.","example":"test1@test.com, test2@test.com"},"acls":{"items":{"type":"string"},"description":"An array containing permissions to apply to the scan.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"user\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["name","enabled","text_targets"]}},"required":["uuid"]}}}},"responses":{"200":{"description":"Returned if the scan was saved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scan."},"uuid":{"type":"string","description":"The UUID for the scan."},"name":{"type":"string","description":"The name of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, webapp, or agent). WAS scans will always have the type set to webapp."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"shared":{"type":"boolean","description":"If `true`, the scan is shared."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The rules for repeating the scan."},"schedule_uuid":{"type":"string","description":"The schedule_uuid of the scan that should be returned."}}},"examples":{"response":{"value":{"scan":{"container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","owner_uuid":"394a4be9-782d-406a-9d0a-695188260f0b","uuid":"template-6950fa18-56c2-fe8b-5f3c-3a6d7b2c406485debdf5bb0ba8ef","name":"Basic WebApp Scan","description":null,"policy_id":37,"scanner_id":null,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","emails":null,"sms":"","enabled":true,"dashboard_file":null,"include_aggregate":true,"scan_time_window":null,"custom_targets":"172.204.81.57:3030","starttime":"20190101T000000","rrules":null,"timezone":null,"notification_filters":null,"shared":0,"user_permissions":128,"default_permissions":0,"owner":"api@api.demo","owner_id":3,"last_modification_date":1545869117,"creation_date":1545869117,"type":"public","id":38}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if an error occurred while saving the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"get":{"summary":"List scans","description":"Returns the scan list. Scans of all types are returned.<p>Requires BASIC [16] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-list","tags":["Scans"],"parameters":[{"description":"The ID of the folder whose scans should be listed.","required":false,"name":"folder_id","in":"query","schema":{"type":"integer"}},{"description":"Limit the results to those that have only changed since this time.","required":false,"name":"last_modification_date","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the scan list.","content":{"application/json":{"schema":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the folder."},"name":{"type":"string","description":"The name of the folder."},"type":{"type":"string","description":"The type of the folder (main, trash, custom)."},"default_tag":{"type":"integer","description":"Whether or not the folder is the default (1 or 0)."},"custom":{"type":"integer","description":"The custom status of the folder (1 or 0)."},"unread_count":{"type":"integer","description":"The number of unread scans in the folder."}}}},"scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scan."},"uuid":{"type":"string","description":"The UUID for the scan."},"name":{"type":"string","description":"The name of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, webapp, or agent). WAS scans will always have the type set to webapp."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"shared":{"type":"boolean","description":"If `true`, the scan is shared."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The rules for repeating the scan."},"schedule_uuid":{"type":"string","description":"The schedule_uuid of the scan that should be returned."}}}},"timestamp":{"type":"integer"}}},"examples":{"response":{"value":{"folders":[{"unread_count":0,"custom":0,"default_tag":0,"type":"trash","name":"Trash","id":18},{"unread_count":0,"custom":0,"default_tag":1,"type":"main","name":"My Scans","id":19},{"unread_count":0,"custom":1,"default_tag":0,"type":"custom","name":"User3","id":34}],"scans":[{"legacy":false,"permissions":128,"type":null,"read":false,"last_modification_date":1543417257,"creation_date":1543417257,"status":"imported","uuid":"9968ccf5-dbbe-efe0-cc4c-a1b348e4eb841b20953abd11a344","shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"428cba1c-8b40-5e3d-bdbb-e74472fade60e4282a12cd401b0b","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"Office - Network Scan - Auth","id":15},{"legacy":false,"permissions":128,"type":null,"read":false,"last_modification_date":1543417225,"creation_date":1543417225,"status":"imported","uuid":"09b50432-e029-201e-89b2-8b733f8a3efa8e53637fa729b116","shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"49e7fc46-ecf4-fbc4-fa85-47c94c41023621febad27bd16e6b","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"DataCenters Scan","id":13},{"legacy":false,"permissions":128,"type":null,"read":false,"last_modification_date":1543417163,"creation_date":1543417163,"status":"imported","uuid":"efce931f-1f65-ac49-b022-78abeefdc085896b4f12aa7e823a","shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"75528521-c3f5-9e31-3a40-c9e6b60d3164a486252826efc36c","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"Office - Agent Scan","id":11},{"legacy":false,"permissions":128,"type":null,"read":false,"last_modification_date":1543426108,"creation_date":1543426108,"status":"imported","uuid":"3a1332e9-71ef-3310-1302-ac82958eaf29423df53aecd40878","shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"b98d669f-350d-a1e4-90e0-f6c4c11858385a3910706fdda295","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"DataCenters Scan","id":21},{"legacy":false,"permissions":128,"type":null,"read":false,"last_modification_date":1543417268,"creation_date":1543417268,"status":"imported","uuid":"920bd8d4-0715-1786-e8d8-58e8073c7aa2d115de514e664c2f","shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"e688787c-0fed-b31c-6152-70478d436ed41ea88435b632b080","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":false,"name":"Cloud - PreAuth - Network Scan - Auth","id":17},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"api@api.demo","schedule_uuid":"template-6950fa18-56c2-fe8b-5f3c-3a6d7b2c406485debdf5bb0ba8ef","timezone":null,"rrules":null,"starttime":"20190101T000000","enabled":true,"control":true,"name":"Basic WebApp Scan","id":38},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"admin@api.demo","schedule_uuid":"template-76bd081d-e946-d72b-99e5-beb5e746e53859260f2708c44a96","timezone":null,"rrules":null,"starttime":null,"enabled":false,"control":true,"name":"test","id":29},{"permissions":128,"type":null,"read":true,"last_modification_date":0,"creation_date":0,"status":"empty","uuid":null,"shared":false,"user_permissions":128,"owner":"api@api.demo","schedule_uuid":"template-e7421587-770f-9cf1-a4b8-4dc90bd0f18887f3bd19e6c05c67","timezone":null,"rrules":null,"starttime":null,"enabled":true,"control":true,"name":"Basic Scan","id":36}],"timestamp":1545869219}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_uuid}":{"get":{"summary":"Get scan details","description":"Returns details for the specified scan.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-details","tags":["Scans"],"parameters":[{"description":"The UUID of the scan to retrieve. While scan UUID is preferred, scan ID is supported.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the scan details.","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object"},"hosts":{"type":"array","items":{"type":"object","properties":{"totalchecksconsidered":{"type":"integer","description":"The total number of checks considered on the host."},"numchecksconsidered":{"type":"integer","description":"The number of checks considered on the host."},"scanprogresstotal":{"type":"integer","description":"The total scan progress for the host."},"scanprogresscurrent":{"type":"integer","description":"The current scan progress for the host."},"host_index":{"type":"string","description":"The index for the host."},"score":{"type":"integer","description":"The overall score for the host."},"severitycount":{"type":"object","properties":{}},"progress":{"type":"string","description":"The scan progress of the host."},"critical":{"type":"integer","description":"The percentage of critical findings on the host."},"high":{"type":"integer","description":"The percentage of high findings on the host."},"medium":{"type":"integer","description":"The percentage of medium findings on the host."},"low":{"type":"integer","description":"The percentage of low findings on the host."},"info":{"type":"integer","description":"The percentage of info findings on the host."},"host_id":{"type":"integer","description":"The unique ID of the host."},"hostname":{"type":"string","description":"The name of the host."}}}},"notes":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"The title of the note."},"message":{"type":"string","description":"The specific message of the note."},"severity":{"type":"integer","description":"The severity of the note."}}}},"vulnerabilities":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"The number of vulnerabilities found."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"vuln_index":{"type":"integer","description":"The index of the vulnerability plugin."},"severity":{"type":"integer","description":"The severity rating of the plugin."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."}}}},"filters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The short name of the filter."},"readable_name":{"type":"string","description":"The long name of the filter."},"operators":{"description":"The comparison options for the filter.","type":"array","items":{"type":"string"}},"control":{"type":"object","properties":{"type":{"type":"string","description":"The input type (entry or dropdown)."},"readable_regest":{"type":"string","description":"The placeholder for the input."},"regex":{"type":"string","description":"A regex for checking the value of the input."},"options":{"description":"A list of options if the input is a dropdown.","type":"array","items":{"type":"string"}}}}}}},"history":{"type":"array","items":{"type":"object","properties":{"alt_targets_used":{"type":"boolean","description":"If `true`, the scan was not launched with a target list. This parameter is `true` for agent scans."},"scheduler":{"type":"integer","description":"If `true`, the scan was launched automatically from a schedule."},"status":{"type":"string","description":"The status of the historical data."},"type":{"type":"string","description":"The type of scan: local, remote, or agent."},"uuid":{"type":"string","description":"The UUID of the historical data."},"last_modification_date":{"type":"integer","description":"The last modification date for the historical data in Unix time."},"creation_date":{"type":"integer","description":"The creation date for the historical data in Unix time."},"owner_id":{"type":"integer","description":"The unique ID of the owner of the scan."},"history_id":{"type":"integer","description":"The unique ID of the historical data."}}}}}},"examples":{"response":{"value":{"info":{"owner":"admin@api.demo","name":"Office - Network Scan - Auth","no_target":false,"folder_id":9,"control":false,"user_permissions":128,"schedule_uuid":"428cba1c-8b40-5e3d-bdbb-e74472fade60e4282a12cd401b0b","edit_allowed":false,"scanner_name":null,"policy":null,"shared":true,"object_id":null,"acls":null,"hostcount":36,"uuid":"9968ccf5-dbbe-efe0-cc4c-a1b348e4eb841b20953abd11a344","status":"imported","scan_type":null,"targets":null,"alt_targets_used":null,"pci-can-upload":null,"scan_start":1543417257,"timestamp":1543417257,"scan_end":1543417257,"haskb":false,"hasaudittrail":false,"scanner_start":null,"scanner_end":null},"history":[{"history_id":10503372,"owner_id":2,"creation_date":1543417257,"last_modification_date":1543417257,"uuid":"9968ccf5-dbbe-efe0-cc4c-a1b348e4eb841b20953abd11a344","type":null,"status":"imported","scheduler":0,"alt_targets_used":false}],"hosts":[{"asset_id":19,"host_id":19,"hostname":"shane.ad.demo.io","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":183,"severitylevel":0},{"count":3,"severitylevel":1},{"count":16,"severitylevel":2},{"count":91,"severitylevel":3},{"count":7,"severitylevel":4}]},"severity":300,"score":162813,"info":183,"low":3,"medium":16,"high":91,"critical":7,"host_index":0},{"asset_id":32,"host_id":32,"hostname":"sam.ad.demo.io","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":151,"severitylevel":0},{"count":2,"severitylevel":1},{"count":11,"severitylevel":2},{"count":100,"severitylevel":3},{"count":8,"severitylevel":4}]},"severity":272,"score":181271,"info":151,"low":2,"medium":11,"high":100,"critical":8,"host_index":2},{"asset_id":33,"host_id":33,"hostname":"alice.ad.demo.io","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":158,"severitylevel":0},{"count":2,"severitylevel":1},{"count":11,"severitylevel":2},{"count":90,"severitylevel":3},{"count":7,"severitylevel":4}]},"severity":268,"score":161278,"info":158,"low":2,"medium":11,"high":90,"critical":7,"host_index":4},{"asset_id":15,"host_id":15,"hostname":"brian.ad.demo.io","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":154,"severitylevel":0},{"count":2,"severitylevel":1},{"count":11,"severitylevel":2},{"count":90,"severitylevel":3},{"count":7,"severitylevel":4}]},"severity":264,"score":161274,"info":154,"low":2,"medium":11,"high":90,"critical":7,"host_index":7},{"asset_id":8,"host_id":8,"hostname":"rita.ad.demo.io","progress":"100-100/200-200","scanprogresscurrent":100,"scanprogresstotal":100,"numchecksconsidered":100,"totalchecksconsidered":100,"severitycount":{"item":[{"count":153,"severitylevel":0},{"count":2,"severitylevel":1},{"count":11,"severitylevel":2},{"count":90,"severitylevel":3},{"count":7,"severitylevel":4}]},"severity":263,"score":161273,"info":153,"low":2,"medium":11,"high":90,"critical":7,"host_index":8}],"vulnerabilities":[{"count":355,"plugin_id":34220,"plugin_name":"Netstat Portscanner (WMI)","severity":0,"plugin_family":"Port scanners","vuln_index":1},{"count":339,"plugin_id":34252,"plugin_name":"Microsoft Windows Remote Listeners Enumeration (WMI)","severity":0,"plugin_family":"Windows","vuln_index":2},{"count":157,"plugin_id":10736,"plugin_name":"DCE Services Enumeration","severity":0,"plugin_family":"Windows","vuln_index":3},{"count":87,"plugin_id":14272,"plugin_name":"Netstat Portscanner (SSH)","severity":0,"plugin_family":"Port scanners","vuln_index":4},{"count":82,"plugin_id":25221,"plugin_name":"Remote listeners enumeration (Linux / AIX)","severity":0,"plugin_family":"Service detection","vuln_index":5}],"comphosts":[],"compliance":[],"filters":[{"name":"host.id","readable_name":"Asset ID","control":{"type":"entry","regex":"[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}(,[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})*","readable_regex":"01234567-abcd-ef01-2345-6789abcdef01"},"operators":["eq","neq","match","nmatch"],"group_name":"vulnerability"},{"name":"plugin.attributes.bid","readable_name":"Bugtraq ID","control":{"type":"entry","regex":"^[0-9]+(,[0-9]+)*","readable_regex":"NUMBER","maxlength":18},"operators":["eq","neq","match","nmatch"],"group_name":"vulnerability"},{"name":"plugin.attributes.exploit_framework_canvas","readable_name":"CANVAS Exploit Framework","control":{"type":"dropdown","list":["true","false"]},"operators":["eq","neq"],"group_name":"vulnerability"},{"name":"plugin.attributes.canvas_package","readable_name":"CANVAS Package","control":{"type":"dropdown","list":["CANVAS","D2ExploitPack","White_Phosphorus"]},"operators":["eq","neq"],"group_name":"vulnerability"},{"name":"plugin.attributes.xref:CERT-CC","readable_name":"CERT Advisory ID","control":{"type":"entry","regex":"^CA-[0-9]+-[0-9]+(,CA-[0-9]+-[0-9]+)*$","readable_regex":"CA-YYYY-ID (ie: CA-2003-08)"},"operators":["eq","neq","match","nmatch"],"group_name":"vulnerability"}],"notes":[],"remediations":{"num_cves":0,"num_hosts":37,"num_remediated_cves":0,"num_impacted_hosts":0,"remediations":[]}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}":{"put":{"summary":"Update scan","description":"Updates the scan configuration. For example, you can enable or disable a scan, change the scan name, description, folder, scanner, targets, and schedule parameters.\n<b>Note: </b>You can specify scan targets as text, input file, or target groups.<p>Requires CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-configure","tags":["Scans"],"parameters":[{"description":"The ID of the scan to change.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID for the editor template to use."},"settings":{"type":"object","properties":{"name":{"type":"string","description":"The name of the scan."},"description":{"type":"string","description":"The description of the scan."},"policy_id":{"type":"integer","description":"The unique ID of the policy to use.","format":"int32"},"folder_id":{"type":"integer","description":"The unique ID of the destination folder for the scan.","format":"int32"},"scanner_id":{"type":"integer","description":"The unique ID of the scanner to use.","example":"1","format":"int32"},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"launch":{"type":"string","description":"When to launch the scan. (Valid values are DAILY, WEEKLY, MONTHLY, YEARLY.)","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"]},"starttime":{"type":"string","description":"The starting time and date for the scan in the following format: YYYYMMDDTHHMMSS.","example":"20140826T133000"},"rrules":{"type":"string","description":"Expects a string of three values separated by semi-colons. The frequency (FREQ=ONETIME or DAILY or WEEKLY or MONTHLY or YEARLY), the interval (INTERVAL=1 or 2 or 3 ... x), and the days of the week (BYDAY=SU,MO,TU,WE,TH,FR,SA). To create a scan that runs every three weeks on Monday Wednesday and Friday the string would be `FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR`","example":"FREQ=DAILY;INTERVAL=1"},"timezone":{"type":"string","description":"The timezone for the scan schedule.","example":"America/New_York"},"text_targets":{"type":"string","description":"A single URL to scan. Required for non-agent scans if no target groups are provided.","example":"localhost"},"emails":{"type":"string","description":"A comma-separated list of accounts who will receive the email summary report.","example":"test1@test.com, test2@test.com"},"acls":{"items":{"type":"string"},"description":"An array containing permissions to apply to the scan.","type":"array","example":"[{\"type\": \"default\", \"permissions\": 16}, {\"type\": \"user\", \"permissions\": 64, \"name\": \"admin\", \"id\": 1, \"owner\": 1}]"}},"required":["enabled","text_targets"]}}}}}},"responses":{"200":{"description":"Returned if the configuration was changed.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scan."},"uuid":{"type":"string","description":"The UUID for the scan."},"name":{"type":"string","description":"The name of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, webapp, or agent). WAS scans will always have the type set to webapp."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"shared":{"type":"boolean","description":"If `true`, the scan is shared."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The rules for repeating the scan."},"schedule_uuid":{"type":"string","description":"The schedule_uuid of the scan that should be returned."}}},"examples":{"response":{"value":{"container_id":"36f234c4-4ae3-4353-9324-8ad3dcc7fcc5","owner_uuid":"394a4be9-782d-406a-9d0a-695188260f0b","uuid":"template-6950fa18-56c2-fe8b-5f3c-3a6d7b2c406485debdf5bb0ba8ef","name":"Basic WebApp Scan","description":null,"policy_id":37,"scanner_id":null,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","emails":null,"sms":"","enabled":false,"dashboard_file":null,"include_aggregate":true,"scan_time_window":null,"custom_targets":"172.204.81.57:3030","starttime":"20181228T000000","rrules":null,"timezone":null,"notification_filters":null,"shared":0,"user_permissions":128,"default_permissions":0,"owner":"api@api.demo","owner_id":3,"last_modification_date":1545870368,"creation_date":1545869117,"type":"public","id":38}}}}}},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if an error occurred while saving the configuration.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete scan","description":"Deletes a scan.\n**Note:** You cannot delete scans in running, paused, or stopping states.<p>Requires CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-delete","tags":["Scans"],"parameters":[{"description":"The ID of the scan to delete.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deleted the scan.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io failed to delete the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/launch":{"post":{"summary":"Launch scan","description":"Launches a scan.<p>Requires CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-launch","tags":["Scans"],"parameters":[{"description":"The ID of the scan to launch.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alt_targets":{"items":{"type":"string"},"description":"If specified, the target will be scanned instead of the default. Value shall be an array with a single URL.","type":"array"}}}}}},"responses":{"200":{"description":"Returned if the scan was successfully launched.","content":{"application/json":{"schema":{"type":"object","properties":{"scan_uuid":{"type":"string","description":"The UUID of the scan."}}},"examples":{"response":{"value":{"scan_uuid":"36984557-946d-4858-8af7-ded422fee78c"}}}}}},"403":{"description":"Returned if the scan is disabled."},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/stop":{"post":{"summary":"Stop scan","description":"Stops a scan.<p>Requires CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-stop","tags":["Scans"],"parameters":[{"description":"The ID of the scan to stop.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully queued the scan to stop.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the scan does not exist."},"409":{"description":"Returned if the scan is not active."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/schedule":{"put":{"summary":"Enable schedule","description":"Enables or disables a scan schedule.<p>Requires CAN CONTROL [32] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-schedule","tags":["Scans"],"parameters":[{"description":"The ID of the scan.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enables or disables the scan schedule."}},"required":["enabled"]}}}},"responses":{"200":{"description":"Returned if Tenable.io enabled or disabled the scan schedule.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"control":{"type":"boolean"},"rrules":{"type":"string"},"starttime":{"type":"string"},"timezone":{"type":"string"}}},"examples":{"response":{"value":{"control":true,"enabled":false,"rrules":"FREQ=DAILY;INTERVAL=1","timezone":"US/Central","starttime":"20181206T230000"}}}}}},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if the scan does not have a schedule to enable.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/was-query/scans/{scan_uuid}/progress":{"get":{"summary":"Check scan status","description":"Retrieve the status of a web application scan that is currently running. Data returned includes scan statistics and the number of plugins identified so far.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-progress","tags":["Scans"],"parameters":[{"description":"The UUID of the scan for which you want to view the progress.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returns the progress of the scan.","content":{"application/json":{"schema":{"type":"object","properties":{"crawled_urls":{"type":"integer"},"queued_urls":{"type":"integer"},"audited_pages":{"type":"integer"},"queued_pages":{"type":"integer"},"request_count":{"type":"integer"},"response_time":{"type":"string"},"assets":{"type":"array","items":{"type":"object"}},"vulnerabilities":{"type":"array","items":{"type":"object"}}}},"examples":{"response":{"value":{"crawled_urls":"integer","queued_urls":"integer","audited_pages":"integer","queued_pages":"integer","request_count":"integer","response_time":"string","assets":[{"name":"string","severities":{"0":{"level":0,"name":"Info","count":"integer"},"1":{"level":1,"name":"Low","count":"integer"},"2":{"level":2,"name":"Medium","count":"integer"},"3":{"level":3,"name":"High","count":"integer"},"4":{"level":4,"name":"Critical","count":"integer"}}}],"vulnerabilities":[{"count":"integer","plugin_family":"string","plugin_id":"integer","plugin_name":"string","severity":"integer"},{"count":"integer","plugin_family":"string","plugin_id":"integer","plugin_name":"string","severity":"integer"},{"count":"integer","plugin_family":"string","plugin_id":"integer","plugin_name":"string","severity":"integer"}]}}}}}},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/status":{"put":{"summary":"Update scan status","description":"Changes the status of a scan.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-read-status","tags":["Scans"],"parameters":[{"description":"The ID of the scan to change.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"read":{"type":"boolean","description":"If `true`, the scan has been read."}},"required":["read"]}}}},"responses":{"200":{"description":"Returned if Tenable.io changed the status.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/copy":{"post":{"summary":"Copy scan","description":"Copies the given scan.<p>Requires CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-copy","tags":["Scans"],"parameters":[{"description":"The ID of the scan to copy.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"integer","description":"The ID of the destination folder.","format":"int32"},"name":{"type":"string","description":"The name of the copied scan."}}}}}},"responses":{"200":{"description":"Returns the copied scan object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scan."},"uuid":{"type":"string","description":"The UUID for the scan."},"name":{"type":"string","description":"The name of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, webapp, or agent). WAS scans will always have the type set to webapp."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"shared":{"type":"boolean","description":"If `true`, the scan is shared."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The rules for repeating the scan."},"schedule_uuid":{"type":"string","description":"The schedule_uuid of the scan that should be returned."}}},"examples":{"response":{"value":{"timezone":null,"enabled":true,"last_modification_date":1545877843,"id":42,"status":"empty","user_permissions":128,"owner":"api@api.demo","starttime":null,"control":true,"uuid":"f09066da-3817-6e3f-7244-8c10c3e0850e3c25cfc9e660ef09","rrules":null,"creation_date":1545868722,"read":false,"shared":false,"name":"Copy of Basic Scan"}}}}}},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if an error occurred while copying.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/import":{"post":{"summary":"Import scan","description":"Import an existing scan uploaded using <a href=\"#file-upload-1\">file: upload</a>.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-import","tags":["Scans"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The name of the file to import as provided by the response from [file: upload](/reference#file-upload)."},"folder_id":{"type":"integer","description":"The ID of the destination folder. If not specified, the default folder will be used.","format":"int32"},"password":{"type":"string","description":"The password for the file to import (required for nessus.db).","format":"password"}},"required":["file"]}}}},"responses":{"200":{"description":"Returns the scan object.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the scan."},"uuid":{"type":"string","description":"The UUID for the scan."},"name":{"type":"string","description":"The name of the scan."},"type":{"type":"string","description":"The type of scan (local, remote, webapp, or agent). WAS scans will always have the type set to webapp."},"owner":{"type":"string","description":"The owner of the scan."},"enabled":{"type":"boolean","description":"If `true`, the schedule for the scan is enabled."},"read":{"type":"boolean","description":"If `true`, the scan has been read."},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."},"shared":{"type":"boolean","description":"If `true`, the scan is shared."},"user_permissions":{"type":"integer","description":"The sharing permissions for the scan."},"creation_date":{"type":"integer","description":"The creation date for the scan in Unix time."},"last_modification_date":{"type":"integer","description":"The last modification date for the scan in Unix time."},"control":{"type":"boolean","description":"If `true`, the scan has a schedule and can be launched."},"starttime":{"type":"string","description":"The scheduled start time for the scan."},"timezone":{"type":"string","description":"The timezone for the scan."},"rrules":{"type":"string","description":"The rules for repeating the scan."},"schedule_uuid":{"type":"string","description":"The schedule_uuid of the scan that should be returned."}}},"examples":{"response":{"value":{"scan":{"timezone":null,"id":38,"last_modification_date":1544219402,"status":"imported","user_permissions":128,"folder_id":null,"owner":"user2@example.com","control":null,"starttime":null,"uuid":"25f3b839-3e4b-aa38-252f-f4614dbe5b170e3fa8eea4c7cb27","rrules":null,"creation_date":1544219402,"read":false,"name":"Basic Scan","shared":false}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io failed to import the scan.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export":{"post":{"summary":"Export scan","description":"Export the given scan. To see the status of the requested export, submit a <a href=\"#was-scan-export-status\">scan export status</a> request. On receiving a \"ready\" status from the was-export-status request, download the export file using the <a href=\"#was-scans-export-download\">scan export download</a> method.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-export-request","tags":["Scans"],"parameters":[{"description":"The ID of the scan to export.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the historical data that should be exported.","required":false,"name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","required":false,"name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The value `web-app`. This parameter is required only when using the API with Web Application Scanning.","required":true,"name":"type","in":"query","schema":{"type":"string","enum":["web-app"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","description":"The file format to use. For Web Application Scanning, supported export formats are Nessus, CSV, and DB.","enum":["nessus","csv","db"]},"password":{"type":"string","description":"The password used to encrypt database exports (\\*Required when exporting as DB).","format":"password"},"chapters":{"type":"string","description":"The chapters to include in the export (expecting a semi-colon delimited string comprised of some combination of the following options: vuln\\_hosts\\_summary, vuln\\_by\\_host, compliance\\_exec, remediations, vuln\\_by\\_plugin, compliance)"}},"required":["format"]}}}},"responses":{"200":{"description":"Returned if the export was queued successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string"},"temp_token":{"type":"string"}}},"examples":{"response":{"value":{"file":"a50d608e-8a05-4521-9896-3f99b2558d30"}}}}}},"400":{"description":"Returned if a required parameter is missing."},"404":{"description":"Returned if the scan does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export/{file_uuid}/status":{"get":{"summary":"Check scan export status","description":"Check the file status of an exported scan. After you request an export, you must poll this endpoint until a \"ready\" status is returned, at which point the file is complete and can be downloaded using the <a href=\"#was-scans-export-download\">was-export-download</a> endpoint.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-export-status","tags":["Scans"],"parameters":[{"description":"The ID of the scan to export.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the file to poll (Included in response from /was-scans/{scan\\_id}/export).","required":true,"name":"file_uuid","in":"path","schema":{"type":"string"}},{"description":"The value `web-app`. This parameter is required only when using the API with Web Application Scanning.","required":true,"name":"type","in":"query","schema":{"type":"string","enum":["web-app"]}}],"responses":{"200":{"description":"Returns the status of the file. A status of `ready` indicates the file can be downloaded.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The export status."}}},"examples":{"response":{"value":{"status":"ready"}}}}}},"404":{"description":"Returned if the file does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/export/{file_uuid}/download":{"get":{"summary":"Download exported scan","description":"Download an exported scan.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-export-download","tags":["Scans"],"parameters":[{"description":"The ID of the scan to export.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the file to download (Included in response from /scans/{scan\\_id}/export).","required":true,"name":"file_uuid","in":"path","schema":{"type":"string"}},{"description":"The value `web-app`. This parameter is required only when using the API with Web Application Scanning.","required":false,"name":"type","in":"query","schema":{"type":"string","enum":["web-app"]}}],"responses":{"200":{"description":"Returns the content of the file as an attachment.","content":{"application/octet-stream":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the file does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/history":{"get":{"summary":"Get scan history","description":"Returns a scan's history records.<p>Requires SCAN OPERATOR [24] user permissions and CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-history","tags":["Scans"],"parameters":[{"description":"The identifier for the scan. This identifier can be the either the `schedule_uuid` or the numeric `id` attribute for the scan. We recommend that you use `schedule_uuid`.","required":true,"name":"scan_id","in":"path","schema":{"type":"string"}},{"description":"Maximum number of objects requested (or service imposed limit if not in request). The max limit value allowed is 50. Must be in the int32 format.","required":false,"name":"limit","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"Offset from request (or zero). Must be in the int32 format.","required":false,"name":"offset","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a scan's history records.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of objects matching your search criteria. Must be in the int32 format."},"limit":{"type":"integer","description":"Maximum number of objects requested (or service imposed limit if not in request). Must be in the int32 format."},"offset":{"type":"integer","description":"Offset from request (or zero). Must be in the int32 format."},"sort":{"description":"An array of objects representing the fields you specified as sort fields in the request message, which Tenable.io uses to sort the returned data.","type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The field on which Tenable.io sorts the results."},"order":{"type":"string","description":"The direction of the sort order. Supported values are `asc` (ascending) and `desc` (descending)."}}}}}},"history":{"type":"array","items":{"type":"object","properties":{"time_end":{"type":"integer","description":"The date the scan completed in Unix time."},"scan_uuid":{"type":"string","description":"The scan history's UUID."},"time_start":{"type":"integer","description":"The date the scan started in Unix time."},"visibility":{"type":"string","description":"The visibility of the scan in workbenches (public or private)."},"targets":{"type":"object","description":"The target parameters used to launch the scan.","properties":{"custom":{"type":"boolean","description":"If `true`, then custom parameters were used to launch the scan."},"default":{"type":"boolean","description":"If `true`, then default parameters were used to launch the scan.."}}},"status":{"type":"string","description":"The status of the scan (completed, aborted, imported, pending, running, resuming, canceling, canceled, pausing, paused, stopping, stopped)."}}}}}},"examples":{"response":{"value":{"pagination":{"offset":0,"total":8,"sort":[{"order":"DESC","name":"start_date"}],"limit":50},"history":[{"time_end":1545945607,"scan_uuid":"1732621d-a7c3-4295-bbc9-37035112ff0a","id":10535512,"time_start":1545945482,"visibility":"public","targets":{"custom":false,"default":null},"status":"canceled"},{"time_end":1545945457,"scan_uuid":"cd5c32e9-0b66-4c31-b61a-8d1bdd8a67ad","id":10535505,"time_start":1545945321,"visibility":"public","targets":{"custom":false,"default":null},"status":"completed"},{"time_end":1545944767,"scan_uuid":"34e04696-2abf-4767-86cb-c51eb26a3511","id":10535496,"time_start":1545944637,"visibility":"public","targets":{"custom":false,"default":null},"status":"completed"},{"time_end":1545877987,"scan_uuid":"47ee2c49-9422-4082-9b5b-48d0883bc76e","id":10534608,"time_start":1545877843,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545877717,"scan_uuid":"0a20f6f1-cb6e-4947-ab71-8121dddff8e9","id":10534601,"time_start":1545877590,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545877057,"scan_uuid":"2b346502-d769-452e-9c2e-0c50033852d2","id":10534598,"time_start":1545876907,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545871897,"scan_uuid":"e80fa271-8a6e-44e8-bdcf-dc75274d4b25","id":10534540,"time_start":1545871758,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"},{"time_end":1545871177,"scan_uuid":"36984557-946d-4858-8af7-ded422fee78b","id":10534536,"time_start":1545871035,"visibility":"public","targets":{"custom":false,"default":null},"status":"aborted"}]}}}}}},"404":{"description":"Returned if Tenable.io cannot find the specified `scan_id`."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/history/{history_uuid}":{"get":{"summary":"Get scan history details","description":"Returns the details of a previous result of a scan.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-history-details","tags":["Scans"],"parameters":[{"description":"The ID of the scan to retrieve.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical scan result to return details about.","required":true,"name":"history_uuid","in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns details of the historical scan result.","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"integer"},"schedule_uuid":{"type":"string"},"scan_start":{"type":"integer"},"scan_end":{"type":"integer"},"owner_uuid":{"type":"string"},"owner":{"type":"string"},"targets":{"type":"string"},"object_id":{"type":"integer"},"uuid":{"type":"string"},"scan_type":{"type":"string"},"name":{"type":"string"}}},"examples":{"response":{"value":{"owner_id":2,"schedule_uuid":"e688787c-0fed-b31c-6152-70478d436ed41ea88435b632b080","status":"imported","scan_start":1543417268,"owner_uuid":"7a676323-47bb-4838-9cec-c9f01448bb2d","owner":"admin@api.demo","targets":null,"object_id":10503373,"uuid":"920bd8d4-0715-1786-e8d8-58e8073c7aa2d115de514e664c2f","scan_end":null,"scan_type":null,"name":"Cloud - PreAuth - Network Scan - Auth"}}}}}},"404":{"description":"Returned if scan_id or history_uuid are not found."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]},"delete":{"summary":"Delete scan history","description":"Deletes historical results from a scan.<p>Requires CAN CONFIGURE [64] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-delete-history","tags":["Scans"],"parameters":[{"description":"The ID of the scan.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the results to delete.","required":true,"name":"history_uuid","in":"path","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Returned if Tenable.io successfully deleted the results.","content":{"application/json":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if Tenable.io could not find the results."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}},"500":{"description":"Returned if Tenable.io failed to delete the results.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":500,"error":"Internal Server Error","message":"An internal server error occurred. Please wait a moment and try your request again."}}}}}},"501":{"description":"Returned if Tenable.io does not support deleting historical scan results.","content":{"application/json":{"examples":{"response":{"value":{"statusCode":501,"error":"Not Implemented","message":"This feature is not yet implemented."}}}}}}},"security":[{"cloud":[]}]}},"/was-query/scans/{scan_uuid}/hosts/{host_id}":{"get":{"summary":"Return host details","description":"Returns details for the specified host.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-host-details","tags":["Scans"],"parameters":[{"description":"The UUID of the scan to retrieve. While scan UUID is preferred, scan ID is supported.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the host to retrieve.","required":true,"name":"host_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the host details.","content":{"application/json":{"schema":{"type":"object","properties":{"info":{"type":"object"},"vulnerabilities":{"type":"array","items":{"type":"object","properties":{"host_id":{"type":"integer","description":"The unique ID of the host where the scan identified the vulnerability."},"hostname":{"type":"string","description":"The name of the host where the scan identified the vulnerability."},"plugin_id":{"type":"integer","description":"The unique ID of the vulnerability plugin."},"plugin_name":{"type":"string","description":"The name of the vulnerability plugin."},"plugin_family":{"type":"string","description":"The parent family of the vulnerability plugin."},"count":{"type":"integer","description":"The number of vulnerabilities found."},"vuln_index":{"type":"integer","description":"The index of the vulnerability plugin."},"severity_index":{"type":"integer","description":"The severity index order of the plugin."},"severity":{"type":"integer","description":"The severity of plugin."}}}}}},"examples":{"response":{"value":{"info":{"mac-address":null,"host-fqdn":"ip-10-10-2-49.ec2.internal","host-ip":"10.10.2.49","operating-system":["Linux Kernel 3.16.0-4-amd64 on Debian 8.7"],"host_end":"Wed Nov 28 15:01:08 2018","host_start":"Wed Nov 28 15:01:08 2018"},"vulnerabilities":[{"count":1,"host_id":8,"hostname":"ip-10-10-2-49.ec2.internal","plugin_family":"General","plugin_id":10114,"plugin_name":"ICMP Timestamp Request Remote Date Disclosure","severity":0,"severity_index":0,"vuln_index":0},{"count":1,"host_id":8,"hostname":"ip-10-10-2-49.ec2.internal","plugin_family":"Service detection","plugin_id":10267,"plugin_name":"SSH Server Type and Version Information","severity":0,"severity_index":0,"vuln_index":0},{"count":1,"host_id":8,"hostname":"ip-10-10-2-49.ec2.internal","plugin_family":"General","plugin_id":10287,"plugin_name":"Traceroute Information","severity":0,"severity_index":0,"vuln_index":0},{"count":1,"host_id":8,"hostname":"ip-10-10-2-49.ec2.internal","plugin_family":"General","plugin_id":10881,"plugin_name":"SSH Protocol Versions Supported","severity":0,"severity_index":0,"vuln_index":0}],"compliance":[]}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/was-query/scans/{scan_uuid}/hosts/{host_id}/plugins/{plugin_id}":{"get":{"summary":"Get plugin output","description":"Returns the output for a given plugin.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-plugin-output","tags":["Scans"],"parameters":[{"description":"The UUID of the scan to retrieve. While scan UUID is preferred, scan ID is supported.","required":true,"name":"scan_uuid","in":"path","schema":{"type":"string"}},{"description":"The ID of the host to retrieve.","required":true,"name":"host_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the plugin to retrieve.","required":true,"name":"plugin_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the historical data that should be returned.","name":"history_id","in":"query","schema":{"type":"integer","format":"int32"}},{"description":"The UUID of the historical data that should be returned.","name":"history_uuid","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the plugin output.","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"array","items":{"type":"object","properties":{"ports":{"type":"object","properties":{}},"has_attachment":{"type":"integer","description":"If the value is `1`, the plugin output contains files that may be exported."},"custom_description":{"type":"string","description":"A custom description of the plugin."},"plugin_output":{"type":"string","description":"The text of the plugin output."},"hosts":{"type":"string","description":"Other hosts with the same output."},"severity":{"type":"integer","description":"The severity of the output."}}}},"info":{"type":"object"}}},"examples":{"response":{"value":{"outputs":[{"ports":{"0 / tcp":[{"hostname":"ip-10-10-2-49.ec2.internal"}]},"has_attachment":0,"severity":0,"plugin_output":"\nHere is the list of packages installed on the remote Debian Linux system : \n\n ii acl 2.2.52-2 amd64 Access control list utilities\n ii adduser 3.113+nmu3 all add and remove users and groups\n ii apt 1.0.9.8.4 amd64 commandline package manager\n ii apt-transport-https 1.0.9.8.4 amd64 https download transport for APT\n ii apt-utils 1.0.9.8.4 amd64 package management related utility programs\n ii awscli 1.4.2-1 all Universal Command Line Environment for AWS\n ii base-files 8+deb8u7 amd64 Debian base system miscellaneous files\n ii base-passwd 3.5.37 amd64 Debian base system master password and group files\n ii bash 4.3-11+deb8u1 amd64 GNU Bourne Again SHell\n ii binutils 2.25-5 amd64 GNU assembler, linker and binary utilities\n ii bsdmainutils 9.0.6 amd64 collection of more utilities from FreeBSD\n ii bsdutils 1:2.25.2-6 amd64 basic utilities from 4.4BSD-Lite\n ii ca-certificates 20141019+deb8u2 all Common CA certificates\n ii cloud-guest-utils 0.29-1~bpo8+1 all cloud guest utilities\n ii cloud-image-utils 0.29-1~bpo8+1 all cloud image management utilities\n ii cloud-init 0.7.7~bzr1156-1~bpo8+1 all initialization system for infrastructure cloud instances\n ii cloud-utils 0.29-1~bpo8+1 all metapackage for installation of upstream cloud-utils source\n ii coreutils 8.23-4 amd64 GNU core utilities\n ii cpio 2.11+dfsg-4.1+deb8u1 amd64 GNU cpio -- a program to manage archives of files\n ii cpp 4:4.9.2-2 amd64 GNU C preprocessor (cpp)\n ii cpp-4.8 4.8.4-1 amd64 GNU C preprocessor\n ii cpp-4.9 4.9.2-10 amd64 GNU C preprocessor\n ii cron 3.0pl1-127+deb8u1 amd64 process scheduling daemon\n ii dash 0.5.7-4+b1 amd64 POSIX-compliant shell\n ii debconf 1.5.56 all Debian configuration management system\n ii debconf-i18n 1.5.56 all full internationalization support for debconf\n ii debian-archive-keyring 2014.3 all GnuPG archive keys of the Debian archive\n ii debianutils 4.4+b1 amd64 Miscellaneous utilities specific to Debian\n ii dh-python 1.20141111-2 all Debian helper tools for packaging Python libraries and applications\n ii diffutils 1:3.3-1+b1 amd64 File comparison utilities\n ii dkms 2.2.0.3-2 all Dynamic Kernel Module Support Framework\n ii dmeventd 2:1.02.90-2.2+deb8u1 amd64 Linux Kernel Device Mapper event daemon\n ii dmidecode 2.12-3 amd64 SMBIOS/DMI table decoder\n ii dmsetup 2:1.02.90-2.2+deb8u1 amd64 Linux Kernel Device Mapper userspace library\n ii docutils-common 0.12+dfsg-1 all text processing system for reStructuredText - common data\n ii dpkg 1.17.27 amd64 Debian package management system\n ii e2fslibs 1.42.12-2+b1 amd64 ext2/ext3/ext4 file system libraries\n ii e2fsprogs 1.42.12-2+b1 amd64 ext2/ext3/ext4 file system utilities\n ii file 1:5.22+15-2+deb8u3 amd64 Determines file type using \"magic\" numbers\n ii findutils 4.4.2-9+b1 amd64 utilities for finding files--find, xargs\n ii gcc 4:4.9.2-2 amd64 GNU C compiler\n ii gcc-4.8 4.8.4-1 amd64 GNU C compiler\n ii gcc-4.8-base 4.8.4-1 amd64 GCC, the GNU Compiler Collection (base package)\n ii gcc-4.9 4.9.2-10 amd64 GNU C compiler\n ii gcc-4.9-base 4.9.2-10 amd64 GCC, the GNU Compiler Collection (base package)\n ii gdisk 0.8.10-2 amd64 GPT fdisk text-mode partitioning tool\n ii genisoimage 9:1.1.11-3 amd64 Creates ISO-9660 CD-ROM filesystem images\n ii gettext-base 0.19.3-2 amd64 GNU Internationalization utilities for the base system\n ii gnupg 1.4.18-7+deb8u3 amd64 GNU privacy guard - a free PGP replacement\n ii gpgv 1.4.18-7+deb8u3 amd64 GNU privacy guard - signature verification tool\n ii grep 2.20-4.1 amd64 GNU grep, egrep and fgrep\n ii groff-base 1.22.2-8 amd64 GNU troff text-formatting system (base system components)\n ii grub-common 2.02~beta2-22+deb8u1 amd64 GRand Unified Bootloader (common files)\n ii grub-pc 2.02~beta2-22+deb8u1 amd64 GRand Unified Bootloader, version 2 (PC/BIOS version)\n ii grub-pc-bin 2.02~beta2-22+deb8u1 amd64 GRand Unified Bootloader, version 2 (PC/BIOS binaries)\n ii grub2-common 2.02~beta2-22+deb8u1 amd64 GRand Unified Bootloader (common files for version 2)\n ii gzip 1.6-4 amd64 GNU compression utilities\n ii hostname 3.15 amd64 utility to set/show the host name or domain name\n ii ifupdown 0.7.53.1 amd64 high level tools to configure network interfaces\n ii init 1.22 amd64 System-V-like init utilities - metapackage\n ii init-system-helpers 1.22 all helper tools for all init systems\n ii initramfs-tools 0.120+deb8u2 all generic modular initramfs generator\n ii initscripts 2.88dsf-59 amd64 scripts for initializing and shutting down the system\n ii insserv 1.14.0-5 amd64 boot sequence organizer using LSB init.d script dependency information\n ii iproute2 3.16.0-2 amd64 networking and traffic control tools\n ii iptables 1.4.21-2+b1 amd64 administration tools for packet filtering and NAT\n ii iputils-ping 3:20121221-5+b2 amd64 Tools to test the reachability of network hosts\n ii isc-dhcp-client 4.3.1-6+deb8u2 amd64 DHCP client for automatically obtaining an IP address\n ii isc-dhcp-common 4.3.1-6+deb8u2 amd64 common files used by all of the isc-dhcp packages\n ii klibc-utils 2.0.4-2 amd64 small utilities built with klibc for early boot\n ii kmod 18-3 amd64 tools for managing Linux kernel modules\n ii less 458-3 amd64 pager program similar to more\n ii libacl1 2.2.52-2 amd64 Access control list shared library\n ii libaio1 0.3.110-1 amd64 Linux kernel AIO access library - shared library\n ii libapt-inst1.5 1.0.9.8.4 amd64 deb package format runtime library\n ii libapt-pkg4.12 1.0.9.8.4 amd64 package management runtime library\n ii libasan0 4.8.4-1 amd64 AddressSanitizer -- a fast memory error detector\n ii libasan1 4.9.2-10 amd64 AddressSanitizer -- a fast memory error detector\n ii libasprintf0c2 0.19.3-2 amd64 GNU library to use fprintf and friends in C++\n ii libatomic1 4.9.2-10 amd64 support library providing __atomic built-in functions\n ii libattr1 1:2.4.47-2 amd64 Extended attribute shared library\n ii libaudit-common 1:2.4-1 all Dynamic library for security auditing - common files\n ii libaudit1 1:2.4-1+b1 amd64 Dynamic library for security auditing\n ii libblkid1 2.25.2-6 amd64 block device id library\n ii libboost-iostreams1.55.0 1.55.0+dfsg-3 amd64 Boost.Iostreams Library\n ii libboost-system1.55.0 1.55.0+dfsg-3 amd64 Operating system (e.g. diagnostics support) library\n ii libboost-thread1.55.0 1.55.0+dfsg-3 amd64 portable C++ multi-threading\n ii libbsd0 0.7.0-2 amd64 utility functions from BSD systems - shared library\n ii libbz2-1.0 1.0.6-7+b3 amd64 high-quality block-sorting file compressor library - runtime\n ii libc-bin 2.19-18+deb8u7 amd64 GNU C Library: Binaries\n ii libc6 2.19-18+deb8u7 amd64 GNU C Library: Shared libraries\n ii libcap2 1:2.24-8 amd64 POSIX 1003.1e capabilities (library)\n ii libcap2-bin 1:2.24-8 amd64 POSIX 1003.1e capabilities (utilities)\n ii libcilkrts5 4.9.2-10 amd64 Intel Cilk Plus language extensions (runtime)\n ii libcloog-isl4 0.18.2-1+b2 amd64 Chunky Loop Generator (runtime library)\n ii libcomerr2 1.42.12-2+b1 amd64 common error description library\n ii libcryptsetup4 2:1.6.6-5 amd64 disk encryption support - shared library\n ii libcurl3-gnutls 7.38.0-4+deb8u5 amd64 easy-to-use client-side URL transfer library (GnuTLS flavour)\n ii libdb5.3 5.3.28-9 amd64 Berkeley v5.3 Database Libraries [runtime]\n ii libdebconfclient0 0.192 amd64 Debian Configuration Management System (C-implementation library)\n ii libdevmapper-event1.02.1 2:1.02.90-2.2+deb8u1 amd64 Linux Kernel Device Mapper event support library\n ii libdevmapper1.02.1 2:1.02.90-2.2+deb8u1 amd64 Linux Kernel Device Mapper userspace library\n ii libdns-export100 1:9.9.5.dfsg-9+deb8u9 amd64 Exported DNS Shared Library\n ii libedit2 3.1-20140620-2 amd64 BSD editline and history libraries\n ii libestr0 0.1.9-1.1 amd64 Helper functions for handling strings (lib)\n ii libexpat1 2.1.0-6+deb8u3 amd64 XML parsing C library - runtime library\n ii libffi6 3.1-2+b2 amd64 Foreign Function Interface library runtime\n ii libfreetype6 2.5.2-3+deb8u1 amd64 FreeType 2 font engine, shared library files\n ii libfuse2 2.9.3-15+deb8u2 amd64 Filesystem in Userspace (library)\n ii libgcc-4.8-dev 4.8.4-1 amd64 GCC support library (development files)\n ii libgcc-4.9-dev 4.9.2-10 amd64 GCC support library (development files)\n ii libgcc1 1:4.9.2-10 amd64 GCC support library\n ii libgcrypt20 1.6.3-2+deb8u2 amd64 LGPL Crypto library - runtime library\n ii libgdbm3 1.8.3-13.1 amd64 GNU dbm database routines (runtime version)\n ii libglib2.0-0 2.42.1-1+b1 amd64 GLib library of C routines\n ii libgmp10 2:6.0.0+dfsg-6 amd64 Multiprecision arithmetic library\n ii libgnutls-deb0-28 3.3.8-6+deb8u4 amd64 GNU TLS library - main runtime library\n ii libgnutls-openssl27 3.3.8-6+deb8u4 amd64 GNU TLS library - OpenSSL wrapper\n ii libgomp1 4.9.2-10 amd64 GCC OpenMP (GOMP) support library\n ii libgpg-error0 1.17-3 amd64 library for common error values and messages in GnuPG components\n ii libgssapi-krb5-2 1.12.1+dfsg-19+deb8u2 amd64 MIT Kerberos runtime libraries - krb5 GSS-API Mechanism\n ii libhogweed2 2.7.1-5+deb8u2 amd64 low level cryptographic library (public-key cryptos)\n ii libicu52 52.1-8+deb8u4 amd64 International Components for Unicode\n ii libidn11 1.29-1+deb8u2 amd64 GNU Libidn library, implementation of IETF IDN specifications\n ii libirs-export91 1:9.9.5.dfsg-9+deb8u9 amd64 Exported IRS Shared Library\n ii libisc-export95 1:9.9.5.dfsg-9+deb8u9 amd64 Exported ISC Shared Library\n ii libisccfg-export90 1:9.9.5.dfsg-9+deb8u9 amd64 Exported ISC CFG Shared Library\n ii libiscsi2 1.12.0-2 amd64 iSCSI client shared library\n ii libisl10 0.12.2-2 amd64 manipulating sets and relations of integer points bounded by linear constraints\n ii libitm1 4.9.2-10 amd64 GNU Transactional Memory Library\n ii libjson-c2 0.11-4 amd64 JSON manipulation library - shared library\n ii libk5crypto3 1.12.1+dfsg-19+deb8u2 amd64 MIT Kerberos runtime libraries - Crypto Library\n ii libkeyutils1 1.5.9-5+b1 amd64 Linux Key Management Utilities (library)\n ii libklibc 2.0.4-2 amd64 minimal libc subset for use with initramfs\n ii libkmod2 18-3 amd64 libkmod shared library\n ii libkrb5-3 1.12.1+dfsg-19+deb8u2 amd64 MIT Kerberos runtime libraries\n ii libkrb5support0 1.12.1+dfsg-19+deb8u2 amd64 MIT Kerberos runtime libraries - Support library\n ii libldap-2.4-2 2.4.40+dfsg-1+deb8u2 amd64 OpenLDAP libraries\n ii liblocale-gettext-perl 1.05-8+b1 amd64 module using libc functions for internationalization in Perl\n ii liblogging-stdlog0 1.0.4-1 amd64 easy to use and lightweight logging library\n ii liblognorm1 1.0.1-3 amd64 Log normalizing library\n ii liblsan0 4.9.2-10 amd64 LeakSanitizer -- a memory leak detector (runtime)\n ii liblvm2cmd2.02 2.02.111-2.2+deb8u1 amd64 LVM2 command library\n ii liblzma5 5.1.1alpha+20120614-2+b3 amd64 XZ-format compression library\n ii libmagic1 1:5.22+15-2+deb8u3 amd64 File type determination library using \"magic\" numbers\n ii libmnl0 1.0.3-5 amd64 minimalistic Netlink communication library\n ii libmount1 2.25.2-6 amd64 device mounting library\n ii libmpc3 1.0.2-1 amd64 multiple precision complex floating-point library\n ii libmpdec2 2.4.1-1 amd64 library for decimal floating point arithmetic (runtime library)\n ii libmpfr4 3.1.2-2 amd64 multiple precision floating-point computation\n ii libncurses5 5.9+20140913-1+b1 amd64 shared libraries for terminal handling\n ii libncursesw5 5.9+20140913-1+b1 amd64 shared libraries for terminal handling (wide character support)\n ii libnetfilter-acct1 1.0.2-1.1 amd64 Netfilter acct library\n ii libnettle4 2.7.1-5+deb8u2 amd64 low level cryptographic library (symmetric and one-way cryptos)\n ii libnewt0.52 0.52.17-1+b1 amd64 Not Erik's Windowing Toolkit - text mode windowing with slang\n ii libnfnetlink0 1.0.1-3 amd64 Netfilter netlink library\n ii libnspr4 2:4.12-1+debu8u1 amd64 NetScape Portable Runtime Library\n ii libnss3 2:3.26-1+debu8u1 amd64 Network Security Service libraries\n ii libp11-kit0 0.20.7-1 amd64 Library for loading and coordinating access to PKCS#11 modules - runtime\n ii libpam-modules 1.1.8-3.1+deb8u2 amd64 Pluggable Authentication Modules for PAM\n ii libpam-modules-bin 1.1.8-3.1+deb8u2 amd64 Pluggable Authentication Modules for PAM - helper binaries\n ii libpam-runtime 1.1.8-3.1+deb8u2 all Runtime support for the PAM library\n ii libpam0g 1.1.8-3.1+deb8u2 amd64 Pluggable Authentication Modules library\n ii libparted2 3.2-7 amd64 disk partition manipulator - shared library\n ii libpcre3 2:8.35-3.3+deb8u4 amd64 Perl 5 Compatible Regular Expression Library - runtime files\n ii libpipeline1 1.4.0-1 amd64 pipeline manipulation library\n ii libpng12-0 1.2.50-2+deb8u3 amd64 PNG library - runtime\n ii libpopt0 1.16-10 amd64 lib for parsing cmdline parameters\n ii libprocps3 2:3.3.9-9 amd64 library for accessing process information from /proc\n ii libpsl0 0.5.1-1 amd64 Library for Public Suffix List (shared libraries)\n ii libpython-stdlib 2.7.9-1 amd64 interactive high-level object-oriented language (default python version)\n ii libpython2.7-minimal 2.7.9-2+deb8u1 amd64 Minimal subset of the Python language (version 2.7)\n ii libpython2.7-stdlib 2.7.9-2+deb8u1 amd64 Interactive high-level object-oriented language (standard library, version 2.7)\n ii libpython3-stdlib 3.4.2-2 amd64 interactive high-level object-oriented language (default python3 version)\n ii libpython3.4-minimal 3.4.2-1 amd64 Minimal subset of the Python language (version 3.4)\n ii libpython3.4-stdlib 3.4.2-1 amd64 Interactive high-level object-oriented language (standard library, version 3.4)\n ii libquadmath0 4.9.2-10 amd64 GCC Quad-Precision Math Library\n ii librados2 0.80.7-2+deb8u2 amd64 RADOS distributed object store client library\n ii librbd1 0.80.7-2+deb8u2 amd64 RADOS block device client library\n ii libreadline5 5.2+dfsg-2 amd64 GNU readline and history libraries, run-time libraries\n ii libreadline6 6.3-8+b3 amd64 GNU readline and history libraries, run-time libraries\n ii librtmp1 2.4+20150115.gita107cef-1 amd64 toolkit for RTMP streams (shared library)\n ii libsasl2-2 2.1.26.dfsg1-13+deb8u1 amd64 Cyrus SASL - authentication abstraction library\n ii libsasl2-modules-db 2.1.26.dfsg1-13+deb8u1 amd64 Cyrus SASL - pluggable authentication modules (DB)\n ii libselinux1 2.3-2 amd64 SELinux runtime shared libraries\n ii libsemanage-common 2.3-1 all Common files for SELinux policy management libraries\n ii libsemanage1 2.3-1+b1 amd64 SELinux policy management library\n ii libsepol1 2.3-2 amd64 SELinux library for manipulating binary security policies\n ii libsigc++-2.0-0c2a 2.4.0-1 amd64 type-safe Signal Framework for C++ - runtime\n ii libslang2 2.3.0-2 amd64 S-Lang programming library - runtime version\n ii libsmartcols1 2.25.2-6 amd64 smart column output alignment library\n ii libsqlite3-0 3.8.7.1-1+deb8u2 amd64 SQLite 3 shared library\n ii libss2 1.42.12-2+b1 amd64 command-line interface parsing library\n ii libssh2-1 1.4.3-4.1+deb8u1 amd64 SSH2 client-side library\n ii libssl1.0.0 1.0.1t-1+deb8u5 amd64 Secure Sockets Layer toolkit - shared libraries\n ii libstdc++6 4.9.2-10 amd64 GNU Standard C++ Library v3\n ii libsystemd0 215-17+deb8u6 amd64 systemd utility library\n ii libtasn1-6 4.2-3+deb8u2 amd64 Manage ASN.1 structures (runtime)\n ii libtext-charwidth-perl 0.04-7+b3 amd64 get display widths of characters on the terminal\n ii libtext-iconv-perl 1.7-5+b2 amd64 converts between character sets in Perl\n ii libtext-wrapi18n-perl 0.06-7 all internationalized substitute of Text::Wrap\n ii libtinfo5 5.9+20140913-1+b1 amd64 shared low-level terminfo library for terminal handling\n ii libtsan0 4.9.2-10 amd64 ThreadSanitizer -- a Valgrind-based detector of data races (runtime)\n ii libubsan0 4.9.2-10 amd64 UBSan -- undefined behaviour sanitizer (runtime)\n ii libudev1 215-17+deb8u6 amd64 libudev shared library\n ii libusb-0.1-4 2:0.1.12-25 amd64 userspace USB programming library\n ii libustr-1.0-1 1.0.4-3+b2 amd64 Micro string library: shared library\n ii libuuid-perl 0.05-1+b1 amd64 Perl extension for using UUID interfaces as defined in e2fsprogs\n ii libuuid1 2.25.2-6 amd64 Universally Unique ID library\n ii libwrap0 7.6.q-25 amd64 Wietse Venema's TCP wrappers library\n ii libxtables10 1.4.21-2+b1 amd64 netfilter xtables library\n ii libyaml-0-2 0.1.6-3 amd64 Fast YAML 1.1 parser and emitter library\n ii linux-base 3.5 all Linux image base package\n ii linux-compiler-gcc-4.8-x86 3.16.39-1 amd64 Compiler for Linux on x86 (meta-package)\n ii linux-headers-3.16.0-4-amd64 3.16.39-1 amd64 Header files for Linux 3.16.0-4-amd64\n ii linux-headers-3.16.0-4-common 3.16.39-1 amd64 Common header files for Linux 3.16.0-4\n ii linux-headers-amd64 3.16+63 amd64 Header files for Linux amd64 configuration (meta-package)\n ii linux-image-3.16.0-4-amd64 3.16.39-1 amd64 Linux 3.16 for 64-bit PCs\n ii linux-image-amd64 3.16+63 amd64 Linux for 64-bit PCs (meta-package)\n ii linux-kbuild-3.16 3.16.7-ckt20-1 amd64 Kbuild infrastructure for Linux 3.16\n ii locales 2.19-18+deb8u7 all GNU C Library: National Language (locale) data [support]\n ii login 1:4.2-3+deb8u1 amd64 system login tools\n ii logrotate 3.8.7-1+b1 amd64 Log rotation utility\n ii lsb-base 4.1+Debian13+nmu1 all Linux Standard Base 4.1 init script functionality\n ii lsb-release 4.1+Debian13+nmu1 all Linux Standard Base version reporting utility\n ii lvm2 2.02.111-2.2+deb8u1 amd64 Linux Logical Volume Manager\n ii make 4.0-8.1 amd64 utility for directing compilation\n ii man-db 2.7.0.2-5 amd64 on-line manual pager\n ii manpages 3.74-1 all Manual pages about using a GNU/Linux system\n ii mawk 1.3.3-17 amd64 a pattern scanning and text processing language\n ii mime-support 3.58 all MIME files `mime.types` & `mailcap`, and support programs\n ii mount 2.25.2-6 amd64 Tools for mounting and manipulating filesystems\n ii multiarch-support 2.19-18+deb8u7 amd64 Transitional package to ensure multiarch compatibility\n ii nano 2.2.6-3 amd64 small, friendly text editor inspired by Pico\n ii ncurses-base 5.9+20140913-1 all basic terminal type definitions\n ii ncurses-bin 5.9+20140913-1+b1 amd64 terminal-related programs and man pages\n ii ncurses-term 5.9+20140913-1 all additional terminal type definitions\n ii net-tools 1.60-26+b1 amd64 NET-3 networking toolkit\n ii netbase 5.3 all Basic TCP/IP networking system\n ii netcat-traditional 1.10-41 amd64 TCP/IP swiss army knife\n ii nfacct 1.0.1-1.1 amd64 netfilter accounting object tool\n ii openssh-client 1:6.7p1-5+deb8u3 amd64 secure shell (SSH) client, for secure access to remote machines\n ii openssh-server 1:6.7p1-5+deb8u3 amd64 secure shell (SSH) server, for secure access from remote machines\n ii openssh-sftp-server 1:6.7p1-5+deb8u3 amd64 secure shell (SSH) sftp server module, for SFTP access from remote machines\n ii openssl 1.0.1t-1+deb8u5 amd64 Secure Sockets Layer toolkit - cryptographic utility\n ii parted 3.2-7 amd64 disk partition manipulator\n ii passwd 1:4.2-3+deb8u1 amd64 change and administer password and group data\n ii patch 2.7.5-1 amd64 Apply a diff file to an original\n ii perl 5.20.2-3+deb8u6 amd64 Larry Wall's Practical Extraction and Report Language\n ii perl-base 5.20.2-3+deb8u6 amd64 minimal Perl system\n ii perl-modules 5.20.2-3+deb8u6 all Core Perl modules\n ii procps 2:3.3.9-9 amd64 /proc file system utilities\n ii python 2.7.9-1 amd64 interactive high-level object-oriented language (default version)\n ii python-boto 2.34.0-2 all Python interface to Amazon's Web Services - Python 2.x\n ii python-chardet 2.3.0-1 all universal character encoding detector for Python2\n ii python-minimal 2.7.9-1 amd64 minimal subset of the Python language (default version)\n ii python-pkg-resources 5.5.1-1 all Package Discovery and Resource Access using pkg_resources\n ii python-requests 2.4.3-6 all elegant and simple HTTP library for Python2, built for human beings\n ii python-six 1.8.0-1 all Python 2 and 3 compatibility library (Python 2 interface)\n ii python-urllib3 1.9.1-3 all HTTP library with thread-safe connection pooling for Python\n ii python2.7 2.7.9-2+deb8u1 amd64 Interactive high-level object-oriented language (version 2.7)\n ii python2.7-minimal 2.7.9-2+deb8u1 amd64 Minimal subset of the Python language (version 2.7)\n ii python3 3.4.2-2 amd64 interactive high-level object-oriented language (default python3 version)\n ii python3-bcdoc 0.12.2-1 all ReST document generation tools for botocore (Python 3)\n ii python3-boto 2.34.0-2 all Python interface to Amazon's Web Services - Python 3.x\n ii python3-botocore 0.62.0-1 all Low-level, data-driven core of boto 3 (Python 3)\n ii python3-chardet 2.3.0-1 all universal character encoding detector for Python3\n ii python3-colorama 0.3.2-1 all Cross-platform colored terminal text in Python - Python 3.x\n ii python3-configobj 5.0.6-1 all simple but powerful config file reader and writer for Python 3\n ii python3-crypto 2.6.1-5+deb8u1 amd64 cryptographic algorithms and protocols for Python 3\n ii python3-dateutil 2.2-2 all powerful extensions to the standard datetime module\n ii python3-docutils 0.12+dfsg-1 all text processing system for reStructuredText (implemented in Python 3)\n ii python3-jinja2 2.7.3-1 all small but fast and easy to use stand-alone template engine\n ii python3-jmespath 0.4.1-1 all JSON Matching Expressions (Python 3)\n ii python3-json-pointer 1.0-2 all resolve JSON pointers - python 3.x\n ii python3-jsonpatch 1.3-5 all library to apply JSON patches - python 3.x\n ii python3-jwt 0.2.1-1+deb8u1 all Python 3 implementation of JSON Web Token\n ii python3-markupsafe 0.23-1+b1 amd64 HTML/XHTML/XML string library for Python 3\n ii python3-minimal 3.4.2-2 amd64 minimal subset of the Python language (default python3 version)\n ii python3-oauthlib 0.6.3-1 all generic, spec-compliant implementation of OAuth for Python3\n ii python3-pkg-resources 5.5.1-1 all Package Discovery and Resource Access using pkg_resources\n ii python3-prettytable 0.7.2-3 all library to represent tabular data in visually appealing ASCII tables (Python3)\n ii python3-requests 2.4.3-6 all elegant and simple HTTP library for Python3, built for human beings\n ii python3-roman 2.0.0-1 all module for generating/analyzing Roman numerals for Python 3\n ii python3-rsa 3.1.4-1+deb8u1 all Pure-Python RSA implementation (Python 3)\n ii python3-serial 2.6-1.1 all pyserial - module encapsulating access for the serial port\n ii python3-six 1.8.0-1 all Python 2 and 3 compatibility library (Python 3 interface)\n ii python3-urllib3 1.9.1-3 all HTTP library with thread-safe connection pooling for Python3\n ii python3-yaml 3.11-2 amd64 YAML parser and emitter for Python3\n ii python3.4 3.4.2-1 amd64 Interactive high-level object-oriented language (version 3.4)\n ii python3.4-minimal 3.4.2-1 amd64 Minimal subset of the Python language (version 3.4)\n ii qemu-utils 1:2.1+dfsg-12+deb8u6 amd64 QEMU utilities\n ii readline-common 6.3-8 all GNU readline and history libraries, common files\n ii rsyslog 8.4.2-1+deb8u2 amd64 reliable system and kernel logging daemon\n ii sed 4.2.2-4+deb8u1 amd64 The GNU sed stream editor\n ii sensible-utils 0.0.9 all Utilities for sensible alternative selection\n ii sgml-base 1.26+nmu4 all SGML infrastructure and SGML catalog file support\n ii startpar 0.59-3 amd64 run processes in parallel and multiplex their output\n ii sudo 1.8.10p3-1+deb8u3 amd64 Provide limited super user privileges to specific users\n ii systemd 215-17+deb8u6 amd64 system and service manager\n ii systemd-sysv 215-17+deb8u6 amd64 system and service manager - SysV links\n ii sysv-rc 2.88dsf-59 all System-V-like runlevel change mechanism\n ii sysvinit-utils 2.88dsf-59 amd64 System-V-like utilities\n ii tar 1.27.1-2+deb8u1 amd64 GNU version of the tar archiving utility\n ii tasksel 3.31+deb8u1 all tool for selecting tasks for installation on Debian systems\n ii tasksel-data 3.31+deb8u1 all official tasks used for installation of Debian systems\n ii traceroute 1:2.0.20-2+b1 amd64 Traces the route taken by packets over an IPv4/IPv6 network\n ii tzdata 2016j-0+deb8u1 all time zone and daylight-saving time data\n ii ucf 3.0030 all Update Configuration File(s): preserve user changes to config files\n ii udev 215-17+deb8u6 amd64 /dev/ and hotplug management daemon\n ii util-linux 2.25.2-6 amd64 Miscellaneous system utilities\n ii vim-common 2:7.4.488-7+deb8u1 amd64 Vi IMproved - Common files\n ii vim-tiny 2:7.4.488-7+deb8u1 amd64 Vi IMproved - enhanced vi editor - compact version\n ii wget 1.16-1+deb8u1 amd64 retrieves files from the web\n ii whiptail 0.52.17-1+b1 amd64 Displays user-friendly dialog boxes from shell scripts\n ii xml-core 0.13+nmu2 all XML infrastructure and XML catalog file support\n ii zlib1g 1:1.2.8.dfsg-2+b1 amd64 compression library - runtime\n","hosts":null,"custom_description":null}],"info":{"plugindescription":{"severity":0,"pluginname":"Software Enumeration (SSH)","pluginattributes":{"risk_information":{"risk_factor":"None"},"plugin_information":{"plugin_version":"$Revision: 1.24 $","plugin_id":22869,"plugin_type":"remote","plugin_publication_date":"2006-10-15T00:00:00Z","plugin_family":"General","plugin_modification_date":"2017-07-28T00:00:00Z"},"solution":"Remove any software that is not in compliance with your organization's acceptable use and security policies.","has_patch":false,"description":"Nessus was able to list the software installed on the remote host by calling the appropriate command (e.g., `rpm -qa` on RPM-based Linux distributions, qpkg, dpkg, etc.).","synopsis":"It was possible to enumerate installed software on the remote host via SSH."},"pluginfamily":"General","pluginid":"22869"}}}}}}}},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/{scan_id}/attachments/{attachment_id}":{"get":{"summary":"Get scan attachment file","description":"Gets the requested scan attachment file.<p>Requires CAN VIEW [16] scan permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-attachments","tags":["Scans"],"parameters":[{"description":"The ID of the scan containing the attachment.","required":true,"name":"scan_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The ID of the scan attachment.","required":true,"name":"attachment_id","in":"path","schema":{"type":"integer","format":"int32"}},{"description":"The attachment access token.","required":true,"name":"key","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the attachment file.","content":{"application/octet-stream":{"schema":{},"examples":{"response":{"value":{}}}}}},"404":{"description":"Returned if the attachment file does not exist."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}},"/scans/timezones":{"get":{"summary":"Get timezones","description":"Returns the timezones list for creating a scan.<p>Requires STANDARD [32] user permissions. See <a href=\"/docs/permissions\">Permissions</a>.</p>","operationId":"was-scans-timezones","tags":["Scans"],"responses":{"200":{"description":"Returns the timezone list.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The readable name of the timezone."},"value":{"type":"string","description":"The system value for the timezone."}}}},"examples":{"response":{"value":{"timezones":[{"name":"Africa/Abidjan","value":"Africa/Abidjan"},{"name":"Europe/Tiraspol","value":"Europe/Tiraspol"},{"name":"UCT","value":"UCT"},{"name":"US/Alaska","value":"US/Alaska"},{"name":"US/Aleutian","value":"US/Aleutian"},{"name":"US/Arizona","value":"US/Arizona"},{"name":"US/Central","value":"US/Central"},{"name":"US/East-Indiana","value":"US/East-Indiana"},{"name":"US/Eastern","value":"US/Eastern"},{"name":"US/Hawaii","value":"US/Hawaii"},{"name":"US/Indiana-Starke","value":"US/Indiana-Starke"},{"name":"US/Michigan","value":"US/Michigan"},{"name":"US/Mountain","value":"US/Mountain"},{"name":"US/Pacific","value":"US/Pacific"},{"name":"US/Pacific-New","value":"US/Pacific-New"},{"name":"US/Samoa","value":"US/Samoa"},{"name":"UTC","value":"UTC"},{"name":"Universal","value":"Universal"},{"name":"W-SU","value":"W-SU"},{"name":"WET","value":"WET"},{"current":true,"name":"Zulu","value":"Zulu"}]}}}}}},"403":{"description":"Returned if the user does not have permission to view timezones."},"429":{"description":"Returned if you attempt to send too many requests in a specific period of time. For more information, see [Rate Limiting](/docs/rate-limiting).","content":{"text/html":{"examples":{"response":{"value":"<html>\n\n<head>\n <title>429 Too Many Requests</title>\n</head>\n\n<body bgcolor=\"white\">\n <center>\n <h1>429 Too Many Requests</h1>\n </center>\n <hr>\n <center>nginx</center>\n</body>\n\n</html>"}}}}}},"security":[{"cloud":[]}]}}},"x-explorer-enabled":true,"x-proxy-enabled":true,"x-samples-enabled":true}