Sign in
Scanner

Create Scan

Create and initiate a new private scan.

post/api/scanner/

Request body

OR

Example request

{
  "name": "My Private Scan",
  "agent_id": 5,
  "targets": [
    "example.com",
    "23.215.0.136",
    "23.192.228.80/30"
  ]
}

Response

Scan Created

idinteger required

Unique identifier for the scan.

namestring required

Descriptive label for the scan.

labelstring required

A system-defined unique label for the index associated with the scan. Used as an identifier.

scan_started_atstring date-time nullable

Timestamp indicating when the scan started.

scan_ended_atstring date-time nullable

Timestamp indicating when the scan ended.

created_atstring date-time required

Timestamp indicating when the scan was created.

rescan_ofinteger nullable

ID of the original scan when this scan was created by a rescan operation; otherwise null.

estimated_time_to_completeinteger

Estimated time in seconds to complete the scan.

queue_positioninteger nullable

Position of the scan in the processing queue.

countinteger

Number of items in the index (e.g. number of collected responses).

is_scan_from_teamboolean required

Indicates whether the scan was initiated by another team member instead of the current user.

modestring required

Scan execution mode.

statestring required

Current state of the scan.

Example response

[
  {
    "id": 89,
    "name": "Test Scan",
    "label": "1764230724-u6lrerkpx",
    "targets": [
      "1.1.1.1"
    ],
    "created_at": "2025-11-27T08:05:24.518270Z",
    "owner": {
      "email": "user@netlas.io",
      "first_name": "FName",
      "last_name": "LName",
      "teams": []
    },
    "is_scan_from_team": false,
    "mode": "top_tcp_ports",
    "state": "done",
    "rescan_of": null,
    "agent": {
      "id": 5,
      "description": "DEMO agent",
      "name": "demo-1",
      "label": "demo-1",
      "location": "RO",
      "ip_address": [
        "2.57.122.18",
        "2.57.122.19"
      ],
      "is_default": true,
      "queue_eta": 260
    }
  }
]

Changes