SitesSLEs

listSiteSleImpactedGateways

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

For WAN SLEs. List the impacted interfaces 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 gateway 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-gateways"
{  "classifier": "",  "end": 1668760746,  "failure": "",  "gateways": [    {      "degraded": 758573.1,      "duration": 2770997,      "gateway_mac": "fc3342001122",      "gateway_model": "SRX320",      "gateway_version": "20.4R1.12",      "name": "test-SRX",      "total": 2770997    }  ],  "limit": 1000,  "metric": "application_health",  "page": 1,  "start": 1668121200,  "total_count": 1}