{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites SLEs API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites SLEs", "type": "folder" }, "items": [ { "info": { "name": "getSiteSleClassifierDetails", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifier/:classifier/summary", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "classifier", "value": "", "type": "path" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" } ] }, "docs": "Get SLE classifier details\n\n\nThis API Endpoint is deprecated and replaced by [Get Site SLE Classifier Summary Trend](/#operations/getSiteSleClassifierSummaryTrend)" }, { "info": { "name": "getSiteSleClassifierSummaryTrend", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifier/:classifier/summary-trend", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "classifier", "value": "", "type": "path" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" } ] }, "docs": "Get SLE classifier Summary Trend" }, { "info": { "name": "listSiteSleMetricClassifiers", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/classifiers", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" } ] }, "docs": "List classifiers for a specific metric" }, { "info": { "name": "getSiteSleHistogram", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/histogram", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" } ] }, "docs": "Get the histogram for the SLE metric" }, { "info": { "name": "getSiteSleImpactSummary", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impact-summary", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "fields", "value": "", "type": "query" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "Get impact summary counts optionally filtered by classifier and failure type\n \n* Wireless SLE Fields: `wlan`, `device_type`, `device_os` ,`band`, `ap`, `server`, `mxedge`\n* Wired SLE Fields: `switch`, `client`, `vlan`, `interface`, `chassis`\n* WAN SLE Fields: `gateway`, `client`, `interface`, `chassis`, `peer_path`, `gateway_zones`" }, { "info": { "name": "listSiteSleImpactedApplications", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-applications", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedAps", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-aps", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wireless SLEs. List the impacted APs optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedChassis", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-chassis", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedWiredClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-clients", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wired SLEs. List the impacted interfaces optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedGateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-gateways", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedInterfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-interfaces", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wired and WAN SLEs. List the impacted interfaces optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedSwitches", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-switches", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wired SLEs. List the impacted switches optionally filtered by classifier and failure type" }, { "info": { "name": "listSiteSleImpactedWirelessClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/impacted-users", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "classifier", "value": "", "type": "query" } ] }, "docs": "For Wireless SLEs. List the impacted wireless users optionally filtered by classifier and failure type" }, { "info": { "name": "getSiteSleSummary", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/summary", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" } ] }, "docs": "Get the summary for the SLE metric\n\n\nThis API Endpoint is deprecated and replaced by [Get Site SLE Summary Trend](/#operations/getSiteSleSummaryTrend)" }, { "info": { "name": "getSiteSleSummaryTrend", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/summary-trend", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" } ] }, "docs": "Get the summary for the SLE metric trend" }, { "info": { "name": "getSiteSleThreshold", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" } ] }, "docs": "Get the SLE threshold" }, { "info": { "name": "replaceSiteSleThreshold", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace the SLE threshold" }, { "info": { "name": "updateSiteSleThreshold", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metric/:metric/threshold", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" }, { "name": "metric", "value": "", "type": "path", "description": "Values from `listSiteSlesMetrics`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the SLE threshold" }, { "info": { "name": "listSiteSlesMetrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/sle/:scope/:scope_id/metrics", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" }, { "name": "scope_id", "value": "", "type": "path", "description": "* site_id if `scope`==`site`\n* device_id if `scope`==`ap`, `scope`==`switch` or `scope`==`gateway`\n* mac if `scope`==`client`" } ] }, "docs": "List the metrics for the given scope" } ] } ], "bundled": true }