Organization

Create a scan task for a given site

Changed on
put/org/sites/{site_id}/scan

Request

  • Base URL
    https://console.rumble.run/api/v1.0
  • Auth
    HTTP bearer

Path parameters

site_idstring uuid required

UUID or name of the site to scan

Request body text/json

targetsstring required
excludesstring
scan-namestring
scan-descriptionstring
scan-frequency'once' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'continuous'
scan-startstring unixtime
scan-tagsstring
scan-grace-periodstring
agentstring uuid
ratestring
max-host-ratestring
passesstring
max-attemptsstring
max-socketsstring
max-group-sizestring
max-ttlstring
tcp-portsstring
tcp-excludesstring
screenshotsstring
nameserversstring
subnet-pingstring
subnet-ping-net-sizestring
subnet-ping-sample-ratestring
host-pingstring
probesstring

Optional probe list, otherwise all probes are used

Example request

{
  "targets": "defaults",
  "scan-name": "My Scan",
  "scan-description": "Scan of Wireless",
  "scan-start": "0",
  "scan-tags": "owner=IT location=Texas",
  "scan-grace-period": "4",
  "agent": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "rate": "10000",
  "max-host-rate": "100",
  "passes": "3",
  "max-attempts": "3",
  "max-sockets": "500",
  "max-group-size": "4096",
  "max-ttl": "255",
  "tcp-ports": "1-1000,5000-6000",
  "tcp-excludes": "9500",
  "screenshots": "true",
  "nameservers": "8.8.8.8",
  "subnet-ping": "true",
  "subnet-ping-net-size": "256",
  "subnet-ping-sample-rate": "3",
  "host-ping": "false",
  "probes": "arp,bacnet,connect,dns,echo,ike,ipmi,mdns,memcache,mssql,natpmp,netbios,pca,rdns,rpcbind,sip,snmp,ssdp,syn,ubnt,wlan-list,wsd"
}

Response

a created scan task

idstring uuid required
namestring
descriptionstring
template_idstring uuid
client_idstring uuid
organization_idstring uuid
agent_idstring uuid
site_idstring uuid
cruncher_idstring uuid
created_atinteger
created_bystring email
created_by_user_idstring uuid
updated_atinteger
typestring
statusstring
errorstring
paramsobject
statsobject
hiddenboolean
parent_idstring uuid
recurboolean
recur_frequencystring
start_timeinteger
recur_lastinteger
recur_nextinteger
recur_last_task_idstring uuid

Example response

{
  "id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "name": "Hourly Scan",
  "description": "Scan the headquarters hourly",
  "template_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "client_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "organization_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "agent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "site_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "cruncher_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "created_at": 1576300370,
  "created_by": "user@example.com",
  "created_by_user_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "updated_at": 1576300370,
  "type": "scan",
  "status": "processed",
  "error": "agent unavailable",
  "parent_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "recur_frequency": "hour",
  "start_time": 1576300370,
  "recur_last": 1576300370,
  "recur_next": 1576300370,
  "recur_last_task_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8"
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property