Connectors
...
Actions
Add Scan
5 min
description adds a scan, depending on access and permissions endpoint url rest/scan method post inputs json body (object) name (string) type (string) description (string) repository (object) id (number) zone (object) id (number) dhcptracking (string) classifymitigatedage (number) schedule (object) type (string) reports (array) id (number) reportsource (string) assets (array) id (number) credentials (array) id (number) emailonlaunch (string) emailonfinish (string) timeoutaction (string) scanningvirtualhosts (string) rollovertype (string) iplist (string) maxscantime (number) output example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "type" "regular", "response" { "id" "4", "name" "posttest", "description" "this is a test for post", "iplist" "", "type" "policy", "policyid" "1000002", "pluginid" " 1", "zoneid" " 1", "dhcptracking" "false", "classifymitigatedage" "0", "emailonlaunch" "false", "emailonfinish" "false", "timeoutaction" "import", "scanningvirtualhosts" "false", "rollovertype" "template", "status" "0", "createdtime" "1406815242", "modifiedtime" "1406815242", "maxscantime" "3600", "ownergid" "0", "reports" \[], "assets" \[], "credentials" \[], "numdependents" "0", "schedule" { "id" "17", "dependentid" "14", "objecttype" "scan", "type" "dependent", "start" "", "repeatrule" "", "enabled" "true", "nextrun" 0, "dependent" { "id" "14", "name" "daily ip scan", "description" "", "status" "1024" } }, "policy" { "id" "1000002", "name" "post test", "description" "test of post for use with scan post test", "uuid" "29f2b9e1 ade9 4550 b63c cea1423e52fc" }, "pluginprefs" \[], "creator" { "id" "1", "username" "head3", "firstname" "", "lastname" "", "uuid" "96f2ad1b 1b83 462e 908a 84e6054f6b64" }, "owner" { "id" "1", "username" "head3", "firstname" "", "lastname" "", "uuid" "96f2ad1b 1b83 462e 908a 84e6054f6b64" }, "repository" { "id" "2", "name" "test", "description" "test", "type" "local", "dataformat" "ipv4", "uuid" "a2ff7e13 2c0e 470e a3c9 e077fe065a54" }, "ownergroup" { "id" "0", "name" "full access", "description" "full access group" }, "uuid" "29f2b9e1 ade9 4550 b63c cea1423e52fc" }, "error code" 0, "error msg" "", "warnings" \[], "timestamp" 1406815242 } } ] output parameters status code (number) reason (string) json body (object) type (string) response (object) id (string) name (string) description (string) iplist (string) type (string) policyid (string) pluginid (string) zoneid (string) dhcptracking (string) classifymitigatedage (string) emailonlaunch (string) emailonfinish (string) timeoutaction (string) scanningvirtualhosts (string) rollovertype (string) status (string) createdtime (string) modifiedtime (string) maxscantime (string) ownergid (string) reports (array) file name (string) – required file (string) – required assets (array) file name (string) – required file (string) – required credentials (array) file name (string) – required file (string) – required numdependents (string) schedule (object) id (string) dependentid (string) objecttype (string) type (string) start (string) repeatrule (string) enabled (string) nextrun (number) dependent (object) id (string) name (string) description (string) status (string) policy (object) id (string) name (string) description (string) uuid (string) pluginprefs (array) file name (string) – required file (string) – required creator (object) id (string) username (string) firstname (string) lastname (string) uuid (string) owner (object) id (string) username (string) firstname (string) lastname (string) uuid (string) repository (object) id (string) name (string) description (string) type (string) dataformat (string) uuid (string) ownergroup (object) id (string) name (string) description (string) uuid (string) error code (number) error msg (string) warnings (array) file name (string) – required file (string) – required timestamp (number)