SitesSLEs
listSiteSleImpactedWiredClients
For Wired SLEs. List the impacted interfaces optionally filtered by classifier and failure type
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
Format
uuidscope*string
enum: gateway, site, switch
Value in
- "gateway"
- "site"
- "switch"
scope_id*string
Format
uuidmetric*string
Values from listSiteSlesMetrics
Query Parameters
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"classifier?string
Filter SLE impact results by classifier
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/sle/gateway/497f6eca-6276-4993-bfeb-53cbbbba6f08/metric/string/impacted-clients"{ "classifier": "", "clients": [ { "degraded": 40, "duration": 11014, "mac": "001122334455", "name": "test-device", "switches": [ { "interfaces": [ "ge-0/0/6" ], "switch_mac": "2c2131001122", "switch_name": "test-ex" } ], "total": 11014 } ], "end": 1668760198, "failure": "", "limit": 1000, "metric": "switch_throughput", "page": 1, "start": 1668726000, "total_count": 1}