triggerSiteDeviceSyntheticTest
Trigger Device Synthetic Test
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidRequest Body
application/json
Request body for triggering a synthetic test on a device
If type==lan_connectivity. Hostname or IP address to probe for LAN connectivity testing
If type==dns. Hostname to resolve during the DNS synthetic test
If type==arp. IP address to resolve through ARP during the synthetic test
If type==radius. Password used for RADIUS authentication testing
passwordIf type==lan_connectivity. Number of ping probes to send during the LAN connectivity test
10 <= value <= 6010If type==lan_connectivity. Whether to include per-ping results in the LAN connectivity test output
falseIf type==lan_connectivity. Payload size, in bytes, for each ping probe
56 <= value <= 6553556If type==speedtest, required for ssr
If type==lan_connectivity. Protocol or protocol combination used for the connectivity test. enum: ping, ping+traceroute, traceroute.
"ping+traceroute"Value in
- "ping"
- "ping+traceroute"
- "traceroute"
If type==curl or type==lan_connectivity
If type==curl. Timeout, in seconds, for the HTTP request
30 <= value <= 12060SRX only, traceroute udp port
0 <= value <= 6553533434Synthetic test type to run against the target. enum: arp, curl, dhcp, dhcp6, dns, lan_connectivity, radius, speedtest.
Value in
- "arp"
- "curl"
- "dhcp"
- "dhcp6"
- "dns"
- "lan_connectivity"
- "radius"
- "speedtest"
If type==curl. URL requested during the HTTP synthetic test
If type==radius. Username used for RADIUS authentication testing
Required for AP. VLAN ID used by the synthetic test when the target device is an AP
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/synthetic_test" \ -H "Content-Type: application/json" \ -d '{ "type": "arp" }'