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

2b1f84425791

Scanner

Get Scanner Agents

Retrieve the list of scanner agents available for initiating private scans from different geolocations.

get/api/scanner/agents/

Response

Scanner Agents

idinteger required

Identifier of the scanner agent to use for the scan.

descriptionstring

Human-readable description of the scanner agent.

namestring required

Agent name.

labelstring required

Agent label.

locationstring required

Agent geolocation as an ISO 3166-1 alpha-2 country code.

ip_addressIpv4[] required

Public IP addresses used by the scanner agent.

is_defaultboolean

Indicates whether this agent is the default scanner agent for the user.

queue_etainteger

Estimated queue waiting time for this agent, in seconds.

Example response

[
  {
    "id": 5,
    "description": "DEMO agent",
    "name": "demo-1",
    "label": "demo-1",
    "location": "RO",
    "ip_address": [
      "2.57.122.18",
      "2.57.122.19"
    ],
    "queue_eta": 260
  }
]