searchSiteSyntheticTest

Search Site Synthetic Testing

Authorization

Authorization<token>

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

site_id*string

Formatuuid

Query Parameters

mac?string

Filter results by MAC address

port_id?string

Filter results by port identifier

vlan_id?string

Filter results by VLAN ID

by?string

Entity who triggers the test

reason?string

Filter results by reason

type?string

Synthetic test type used to filter results. enum: arp, curl, dhcp, dhcp6, dns, lan_connectivity, radius, speedtest

Value in

"arp"
"curl"
"dhcp"
"dhcp6"
"dns"
"lan_connectivity"
"radius"
"speedtest"

protocol?string

Connectivity protocol used to filter synthetic test results. enum: ping, traceroute

Value in

"ping"
"traceroute"

tenant?string

Filter results by tenant network

limit?integer

Maximum number of results to return per page

Range0 <= value

Default100

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"

search_after?string

Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/synthetic_test/search"

{  "end": 0,  "limit": 0,  "next": "string",  "results": [    {      "by": "user",      "device_type": "gateway",      "failed": false,      "latency": 40,      "mac": "aff827549235",      "port_id": "ge-0/0/2",      "rx_mbps": 322,      "timestamp": 1706824045.059036,      "tx_mbps": 199,      "type": "speedtest",      "vlan_id": 20    },    {      "by": "marvis",      "device_type": "gateway",      "failed": true,      "latency": 0,      "mac": "8396cd006c8c",      "port_id": "ge-0/0/2",      "reason": "interface not ready to perform test",      "rx_mbps": 0,      "timestamp": 1706824045.059036,      "tx_mbps": 0,      "type": "speedtest",      "vlan_id": 100    }  ],  "start": 0,  "total": 0}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

Authorization

Path Parameters

Query Parameters

Response Body