Launch New Scan

description launches a new scan endpoint url /api/1 0/scans/new method post inputs json body (object) targeturi (string) istargeturlrequired (boolean) createtype (string) additionalwebsites (array) canonical (boolean) targeturl (string) basicauthenticationapimodel (object) credentials (array) authenticationtype (string) domain (string) password (string) uriprefix (string) username (string) isreplacedcredentials (boolean) isenabled (boolean) nochallenge (boolean) clientcertificateauthenticationsetting (object) file (object) content (string) filename (string) type (string) isenabled (boolean) password (string) cookies (string) crawlandattack (boolean) enableheuristicchecksincustomurlrewrite (boolean) excludedlinks (array) regexpattern (string) excludedusagetrackers (array) url (string) disallowedhttpmethods (array) file name (string) – required file (string) – required excludelinks (boolean) excludeauthenticationpages (boolean) findandfollownewlinks (boolean) formauthenticationsettingmodel (object) integrations (object) customscripts (array) file name (string) – required file (string) – required interactiveloginrequired (boolean) defaultpersonavalidation (boolean) detectbearertoken (boolean) enablediagnosticslogging (boolean) disablelogoutdetection (boolean) isenabled (boolean) isnotverified (boolean) loginformurl (string) loginrequiredurl (string) logoutkeywordpatterns (array) pattern (string) regex (boolean) logoutkeywordpatternsvalue (string) logoutredirectpattern (string) overridetargeturl (boolean) personas (array) isactive (boolean) password (string) username (string) otptype (string) secretkey (string) digit (number) period (number) algorithm (string) formauthtype (string) integrationid (string) version (string) usestaticusername (boolean) cyberarkusestaticusername (boolean) azureusestaticusername (boolean) isreplacedcredentials (boolean) index (number) personasvalidation (boolean) authorizationtokenrules (array) file name (string) – required file (string) – required headerauthentication (object) headers (array) name (string) value (string) isreplacedcredentials (boolean) isenabled (boolean) authenticationprofileoption (string) importedlinks (array) importedfiles (array) content (string) filename (string) importertype (string) type (string) url (string) apiurl (string) ismaxscandurationenabled (boolean) maxdynamicsignatures (number) maxscanduration (number) scope (string) subpathmaxdynamicsignatures (number) timewindow (object) items (array) day (string) from (string) scanningallowed (boolean) to (string) urlrewriteanalyzableextensions (string) urlrewriteblockseparators (string) urlrewritemode (string) urlrewriterules (array) placeholderpattern (string) prerequestscriptsetting (object) isenabled (boolean) donotdifferentiateprotocols (boolean) oauth2settingmodel (object) flowtype (string) authenticationtype (string) accesstokenendpoint (object) url (string) contenttype (string) method (string) authorizationcodeendpoint (object) url (string) contenttype (string) method (string) accesstokenitems (array) name (string) value (string) isencoded (boolean) isencrypted (boolean) authorizationcodeitems (array) name (string) value (string) isencoded (boolean) isencrypted (boolean) responsefields (object) accesstoken (string) refreshtoken (string) expire (string) tokentype (string) istokentypefixed (boolean) threeleggedfields (object) enabled (boolean) username (string) password (string) customscripts (array) file name (string) – required file (string) – required enabled (boolean) enablepciscantask (boolean) tags (array) comments (string) output example \[ { "status code" 201, "response headers" { "date" "thu, 28 mar 2024 10🕛00 gmt", "content type" "application/json; charset=utf 8", "content length" "70", "connection" "keep alive", "cache control" "no cache", "pragma" "no cache", "expires" " 1", "x content type options" "nosniff", "x frame options" "deny", "referrer policy" "no referrer", "x xss protection" "1; mode=block", "origin trial" "au1hlo38hdou0c5ahko3bugr8p9kt881bvrccp4vesne1hv+b1xx/mzhfznp/tww4+bpblko9h3fokvwcxzdsqaaaabieyjvcmlnaw4ioijodhrwczovl3d3dy5uzxrzcgfya2vyy2xvdwquy29tojq0myisimzlyxr1cmuioijvmkztzwn1cml0eutleufqssisimv4cglyesi6mty1odg3otk5ox0=", "strict transport security" "max age=31536000; includesubdomains; preload", "expect ct" "max age=30,report uri=\\"https //www netsparkercloud com/report ct/\\"" }, "reason" "ok", "json body" \[ { "additionalwebsites" \[ { "canonical" true, "targeturl" "string" } ], "agentid" "00000000 0000 0000 0000 000000000000", "agentname" "string", "cookies" "string", "crawlandattack" true, "deletedon" "2024 03 28t06 07 58 129z", "enableheuristicchecksincustomurlrewrite" true, "excludedlinks" "string", "excludelinks" true, "disallowedhttpmethods" "string", "findandfollownewlinks" true, "importedlinks" "string", "allimportedlinks" "string", "desktopscanid" "00000000 0000 0000 0000 000000000000", "initiatedtime" "string", "initiateddate" "string", "initiatedat" "2024 03 28t06 07 58 129z", "maxdynamicsignatures" 0, "maxscanduration" 0, "duration" "string", "policydescription" "string", "policyid" "00000000 0000 0000 0000 000000000000", "policyuserid" "00000000 0000 0000 0000 000000000000", "policyisdefault" true, "policyisshared" true, "policyname" "string", "authenticationprofileid" "00000000 0000 0000 0000 000000000000", "authenticationprofileoption" "dontuse", "reportpolicydescription" "string", "reportpolicyid" "00000000 0000 0000 0000 000000000000", "reportpolicyuserid" "00000000 0000 0000 0000 000000000000", "reportpolicyisdefault" true, "reportpolicyisshared" true, "reportpolicyname" "string", "scope" "enteredpathandbelow", "subpathmaxdynamicsignatures" 0, "targetpath" "string", "targeturl" "string", "targeturlroot" "string", "timewindow" { "items" \[ { "day" "sunday", "from" "string", "scanningallowed" true, "to" "string" } ] }, "totalvulnerabilitycount" 0, "urlrewriteanalyzableextensions" "string", "urlrewriteblockseparators" "string", "urlrewritemode" "none", "urlrewriterules" \[ { "placeholderpattern" "string", "regexpattern" "string" } ], "urlrewriteexcludedlinks" \[ { "excludedpath" "string", "isregex" true } ], "userid" "00000000 0000 0000 0000 000000000000", "vcscommitinfo" { "cibuildconfigurationname" "string", "cibuildhaschange" true, "cibuildid" "string", "cibuildservername" "string", "cibuildserverversion" "string", "cibuildurl" "string", "cincpluginversion" "string", "citimestamp" "2024 03 28t06 07 58 129z", "comitterid" "00000000 0000 0000 0000 000000000000", "committer" "string", "committername" "string", "committeroverride" "string", "integrationsystem" "teamcity", "iscommiterexistandauthorizedinnc" true, "vcsname" "string", "vcsversion" "string" }, "websitename" "string", "websiteurl" "string", "websitedescription" "string", "websiteprotocol" "http", "websiteisdeleted" true, "iswebsitelatestcompletedfullscantask" true, "enablepciscantask" true, "pciscantask" { "name" "string", "progress" 0, "scanstate" "new", "compliancestatus" "scanning", "enddate" "2024 03 28t06 07 58 129z" }, "username" "string", "queuedscantaskexist" true, "scantaskprofileid" "00000000 0000 0000 0000 000000000000", "scantaskprofile" { "id" "00000000 0000 0000 0000 000000000000", "ismine" true, "isprimary" true, "isshared" true, "name" "string", "targeturl" "string", "scanpolicyname" "string", "tags" \[ "string" ] }, "websitegroupids" \[ "00000000 0000 0000 0000 000000000000" ], "comments" "string", "businesslogicrecordersetting" { "sequencemodellist" \[ { "name" "string", "businesslogicrecordersettings" "string" } ] }, "scanprofilechanged" true, "completedsteps" 0, "estimatedlaunchtime" 0, "estimatedsteps" 0, "failurereason" "none", "failurereasondescription" "string", "failurereasonstring" "string", "globalthreatlevel" "unknown", "globalvulnerabilitycriticalcount" 0, "globalvulnerabilityhighcount" 0, "globalvulnerabilityinfocount" 0, "globalvulnerabilitybestpracticecount" 0, "globalvulnerabilitylowcount" 0, "globalvulnerabilitymediumcount" 0, "id" "00000000 0000 0000 0000 000000000000", "iscompleted" true, "percentage" 0, "phase" "pending", "scantaskgroupid" "00000000 0000 0000 0000 000000000000", "scantype" "full", "scheduledscanid" "00000000 0000 0000 0000 000000000000", "state" "queued", "statechanged" "2024 03 28t06 07 58 129z", "threatlevel" "unknown", "vulnerabilitycriticalcount" 0, "vulnerabilityhighcount" 0, "vulnerabilityinfocount" 0, "vulnerabilitybestpracticecount" 0, "vulnerabilitylowcount" 0, "vulnerabilitymediumcount" 0, "websiteid" "00000000 0000 0000 0000 000000000000", "initiated" "2024 03 28t06 07 58 129z", "tags" \[ "string" ] } ] } ] output parameters status code (number) reason (string) json body (array) additionalwebsites (array) canonical (boolean) targeturl (string) agentid (string) agentname (string) cookies (string) crawlandattack (boolean) deletedon (string) enableheuristicchecksincustomurlrewrite (boolean) excludedlinks (string) excludelinks (boolean) disallowedhttpmethods (string) findandfollownewlinks (boolean) importedlinks (string) allimportedlinks (string) desktopscanid (string) initiatedtime (string) initiateddate (string) initiatedat (string) maxdynamicsignatures (number) maxscanduration (number) duration (string) policydescription (string) policyid (string) policyuserid (string) policyisdefault (boolean) policyisshared (boolean) policyname (string) authenticationprofileid (string) authenticationprofileoption (string) reportpolicydescription (string) reportpolicyid (string) reportpolicyuserid (string) reportpolicyisdefault (boolean) reportpolicyisshared (boolean) reportpolicyname (string) scope (string) subpathmaxdynamicsignatures (number) targetpath (string) targeturl (string) targeturlroot (string) timewindow (object) items (array) day (string) from (string) scanningallowed (boolean) to (string) totalvulnerabilitycount (number) urlrewriteanalyzableextensions (string) urlrewriteblockseparators (string) urlrewritemode (string) urlrewriterules (array) placeholderpattern (string) regexpattern (string) urlrewriteexcludedlinks (array) excludedpath (string) isregex (boolean) userid (string) vcscommitinfo (object) cibuildconfigurationname (string) cibuildhaschange (boolean) cibuildid (string) cibuildservername (string) cibuildserverversion (string) cibuildurl (string) cincpluginversion (string) citimestamp (string) comitterid (string) committer (string) committername (string) committeroverride (string) integrationsystem (string) iscommiterexistandauthorizedinnc (boolean) vcsname (string) vcsversion (string) websitename (string) websiteurl (string) websitedescription (string) websiteprotocol (string) websiteisdeleted (boolean) iswebsitelatestcompletedfullscantask (boolean) enablepciscantask (boolean) pciscantask (object) name (string) progress (number) scanstate (string) compliancestatus (string) enddate (string) username (string) queuedscantaskexist (boolean) scantaskprofileid (string) scantaskprofile (object) id (string) ismine (boolean) isprimary (boolean) isshared (boolean) name (string) targeturl (string) scanpolicyname (string) tags (array) websitegroupids (array) comments (string) businesslogicrecordersetting (object) sequencemodellist (array) name (string) businesslogicrecordersettings (string) scanprofilechanged (boolean) completedsteps (number) estimatedlaunchtime (number) estimatedsteps (number) failurereason (string) failurereasondescription (string) failurereasonstring (string) globalthreatlevel (string) globalvulnerabilitycriticalcount (number) globalvulnerabilityhighcount (number) globalvulnerabilityinfocount (number) globalvulnerabilitybestpracticecount (number) globalvulnerabilitylowcount (number) globalvulnerabilitymediumcount (number) id (string) iscompleted (boolean) percentage (number) phase (string) scantaskgroupid (string) scantype (string) scheduledscanid (string) state (string) statechanged (string) threatlevel (string) vulnerabilitycriticalcount (number) vulnerabilityhighcount (number) vulnerabilityinfocount (number) vulnerabilitybestpracticecount (number) vulnerabilitylowcount (number) vulnerabilitymediumcount (number) websiteid (string) initiated (string) tags (array) response headers header type date string content type string content length string connection string cache control string pragma string expires string x content type options string x frame options string referrer policy string x xss protection string origin trial string strict transport security string expect ct string