Sign in
latestOpenAPI 3.0.3Netlas API & Data License Agreement2026-08-104487309.0 KB

2b1f84425791

Scanner

Update Scan

Update the label of a private scan using its id.

patch/api/scanner/{id}/

Path parameters

idinteger required

Unique identifier for the scan.

Example:123

Request body

namestring

Descriptive label for the scan.

Example request

{
  "name": "My Private Scan"
}

Response

Scan Updated

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.

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",
  "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
  }
}