SitesSLEs

listSiteSleImpactedSwitches

GET
/api/v1/sites/{site_id}/sle/{scope}/{scope_id}/metric/{metric}/impacted-switches

For Wired SLEs. List the impacted switches optionally filtered by classifier and failure type

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
scope*"site"

Scope parameter value for impacted switch SLE queries. enum: site

Value in

  • "site"
scope_id*string
Formatuuid
metric*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/site/497f6eca-6276-4993-bfeb-53cbbbba6f08/metric/string/impacted-switches"
{  "classifier": "",  "end": 1668760198,  "failure": "",  "limit": 1000,  "metric": "switch_throughput",  "page": 1,  "start": 1668726000,  "switches": [    {      "degraded": 109.88333,      "duration": 5753.75,      "interface": [        "ge-0/0/11",        "xe-0/1/0"      ],      "name": "test-ex",      "switch_mac": "2c2131001122",      "switch_model": "EX2300-C-12P",      "switch_version": "20.4R3-S3.4",      "total": 5753.75    }  ],  "total_count": 1}