Update all fields of a NetworkScan

put

https://clearpass-hostname/api/config/network-scan/{scan_id}

Path Params

scan_id

string

required

Numeric ID of the NetworkScan

Body Params

zone

string

required

Zone for the Network Scan

type

string

enum

required

Type of the Network Scan

Allowed:

seed_device_or_ip_subnet

string

required

Network IP for DISCOVERY (e.g. ["hostname.example.com", "1.2.3.4"]) or IP Subnets for SUBNET (e.g. ["10.1.0.0/16"]) Network Scan

scan_frequency

string

enum

required

Frequency of Network Scan

Allowed:

start_time

string

Start time (HH:MM) of Network Scan (e.g. ["10:40", "23:20"])

interval

int64

Interval in hours (3 - 350) for HOURLY Network Scan

day_of_week

string

enum

Day of Week for WEEKLY Network Scan

Allowed:

depth

integer

enum

Depth level for DISCOVERY Network Scan

Allowed:

probe_arp

boolean

Probe all ARP entries found (default=false for type="DISCOVERY", not applicable for type="SUBNET")

enabled

boolean

Is Network Scan enabled? (default=true)

Responses

Language

Response

Choose an example:

application/json

200OK

204No Content

304Not Modified

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

415Unsupported Media Type

422Unprocessable Entity