{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Services API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Services", "type": "folder" }, "items": [ { "info": { "name": "listSiteServicesDerived", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/services/derived", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "resolve", "value": "", "type": "query", "description": "Whether resolve the site variables" } ] }, "docs": "Get the list of derived Services for a Site" }, { "info": { "name": "countSiteServicePathEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/services/events/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query", "description": "Event type, e.g. GW_SERVICE_PATH_DOWN" }, { "name": "text", "value": "", "type": "query", "description": "Description of the event including the reason it is triggered" }, { "name": "vpn_name", "value": "", "type": "query", "description": "Peer name" }, { "name": "vpn_path", "value": "", "type": "query", "description": "Peer path name" }, { "name": "policy", "value": "", "type": "query", "description": "Service policy associated with that specific path" }, { "name": "port_id", "value": "", "type": "query", "description": "Network interface" }, { "name": "model", "value": "", "type": "query", "description": "Device model" }, { "name": "version", "value": "", "type": "query", "description": "Device firmware version" }, { "name": "timestamp", "value": "", "type": "query", "description": "Start time, in epoch" }, { "name": "mac", "value": "", "type": "query", "description": "MAC address" }, { "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": "limit", "value": "", "type": "query" } ] }, "docs": "Count by Distinct Attributes of Service Path Events" }, { "info": { "name": "searchSiteServicePathEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/services/events/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query", "description": "Event type, e.g. GW_SERVICE_PATH_DOWN" }, { "name": "text", "value": "", "type": "query", "description": "Description of the event including the reason it is triggered" }, { "name": "peer_port_id", "value": "", "type": "query", "description": "Port ID of the peer gateway" }, { "name": "peer_mac", "value": "", "type": "query", "description": "MAC address of the peer gateway" }, { "name": "vpn_name", "value": "", "type": "query", "description": "Peer name" }, { "name": "vpn_path", "value": "", "type": "query", "description": "Peer path name" }, { "name": "policy", "value": "", "type": "query", "description": "Service policy associated with that specific path" }, { "name": "port_id", "value": "", "type": "query", "description": "Network interface" }, { "name": "model", "value": "", "type": "query", "description": "Device model" }, { "name": "version", "value": "", "type": "query", "description": "Device firmware version" }, { "name": "timestamp", "value": "", "type": "query", "description": "Start time, in epoch" }, { "name": "mac", "value": "", "type": "query", "description": "MAC address" }, { "name": "limit", "value": "", "type": "query" }, { "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": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order" }, { "name": "search_after", "value": "", "type": "query", "description": "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." } ] }, "docs": "Search Service Path Events" } ] } ], "bundled": true }