Update scan
PUT {{baseUrl}}/scans/:scan_id
Updates the scan configuration. For example, you can enable or disable a scan, change the scan name, description, folder, scanner, targets, and schedule parameters. For more information and request body examples, see Update a Scan.
Requires SCAN OPERATOR [24] user permissions and CAN CONFIGURE [64] scan permissions. See Permissions.
Request Body
{"uuid"=>"ab4bacd2-05f6-425c-9d79-3ba3940ad1c24e51e1f403febe40", "settings"=>{"name"=>"cupidatat ex ullamco", "description"=>"do aliquip", "folder_id"=>-27246876, "owner_id"=>-65092824, "scanner_id"=>"00000000-0000-0000-0000-00000000000000000000000000001", "target_network_uuid"=>"00000000-0000-0000-0000-000000000000", "enabled"=>false, "launch"=>"MONTHLY", "scan_time_window"=>46081235, "starttime"=>"20140826T133000", "rrules"=>"cillum elit ipsum", "timezone"=>"America/New_York", "text_targets"=>"localhost", "target_groups"=>[-76920762, -87918185], "file_targets"=>"scan_targets.txt", "tag_targets"=>["adipisicing", "in deseru"], "agent_group_id"=>["adipisicing anim occaecat", "aute consectetur dolore"], "emails"=>"test1@test.com, test2@test.com", "acls"=>[{"permissions"=>93494838, "owner"=>83687445, "display_name"=>"sit", "name"=>"aute ipsum incididunt mollit", "id"=>22006458, "type"=>"sunt adi"}, {"permissions"=>32234186, "owner"=>-26208721, "display_name"=>"magna voluptate", "name"=>"in U", "id"=>-70703788, "type"=>"ut eiusmod"}]}, "credentials"=>{"add"=>{"Host"=>{"Windows"=>[{"domain"=>"consectetur la", "username"=>"magna", "auth_method"=>"Password", "password"=>"amet occaecat sunt do"}, {"domain"=>"mollit", "username"=>"proident esse", "auth_method"=>"Password", "password"=>"ullamco laboris non Ut"}]}}, "delete"=>["qui enim", "ea dolor aute ut"]}, "plugins"=>{"Web Servers"=>{"individual"=>{"11213"=>"enabled", "18261"=>"enabled"}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"container_id":"40ac4662-6af3-4a0b-b422-93387ec0f298","owner_uuid":"50f84b7f-d1d3-4182-bb46-79cf5c51806e","uuid":"template-c311aa94-82d0-7827-6c71-72978df15544f4f660ba792e0b0f","name":"Basic Daily Network Scan","description":"Scan all hosts daily","policy_id":16,"scanner_id":null,"scanner_uuid":"00000000-0000-0000-0000-00000000000000000000000000001","emails":"","sms":"","enabled":false,"dashboard_file":null,"include_aggregate":true,"scan_time_window":null,"custom_targets":null,"starttime":null,"rrules":null,"timezone":"US/Central","notification_filters":[{"value":"Critical","quality":"eq","filter":"risk_factor"}],"tag_targets":["6fb39d03-fc3d-470d-96f1-6dbb7bef1f51","715f11cc-c503-4a73-9dc2-cbfb1089616d"],"shared":0,"user_permissions":128,"default_permissions":0,"owner":"user2@example.com","owner_id":2,"last_modification_date":1544207231,"creation_date":1544145190,"type":"public","id":26}