Scan remote hosts - ad hoc

post

https://{sandfly-api-host}/v4/scan/adhoc

Scan remote hosts on an ad hoc basis with supplied key and sandflies.

Body Params

Ad hoc scan JSON.

credentials

object of objects

Credentials object to add at same time as adding these hosts.

hosts

object of objects

Hosts object of hosts to add

jump_hosts

array of objects

List of jump_host objects to use for adding this host.

jump_hosts

priority

int32

Optional priority to use for scan between -20 high priority and 19 low priority - Default is 0.

queue_name

string

scanning node queue name to use to for scan request.

sandfly_list

array of strings

A list of sandflies to use in the scan.

sandfly_list

ssh_host_keys

object

Expected SSH host public keys of the hosts to add. If a host key isn't provided for a host, any key will be accepted.

tags

verify_host_key

boolean

If true, the SSH key of the host will be recorded during the Host Add operation, then on future scans Sandfly will not authenticate to the host if the host key changes.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Remote scan accepted for processing.

400A required parameter was not found or other error happened.

403A licensing violation occurred.

defaultUnexpected error