Skip to main content
POST
Start On-Demand Multi-IP Scan

Authorizations

Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Body

application/json

Details of the scan to initiate.

schedule_id
string<uuid>
required

The ID of the schedule whose configuration will be used for the scan.

Example:

"9c43cc95-f313-49a3-b632-524f7a24503b"

site_id
string<uuid>
required

The ID of the site where the target IP addresses are located.

Example:

"9c3c1392-7f36-4240-85f2-273573c0384a"

ips
string<ipv4>[]
required

A list of specific IPv4 addresses to scan.

Example:

Response

The multi-IP scan has been created and queued for execution.

scan_id
string<uuid>

The unique identifier for the newly created parent scan object.

Example:

"9c46a6f1-a8d8-4f5a-9b2f-7d1b3e9c5a1d"

scan_site_id
string<uuid>

The unique identifier for this specific site scan instance.

Example:

"9c46a6f1-b9e9-4f5a-9b2f-8e2c4f0d6b2e"

target_ips
string<ipv4>[]
Example:
message
string
Example:

"Scan started successfully"