{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Sites Synthetic Tests API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Sites Synthetic Tests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "triggerSiteSwitchRadiusSyntheticTest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/check_radius_server",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Ping test from the AP to confirm 'reachability' of the RADIUS server. \n\nUtilize Juniper EX switch(to which an AP is connected to) radius test capabilities to get details on the RADIUS Server 'availability'.\n\n\n\n#### Subscribe to Device Command outputs\n\n`WS /api-ws/v1/stream`\n\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n\n#### Example output from ws stream\n\n```json\n{\n  \"event\": \"data\",\n  \"channel\": \"/sites/d6fb4f96-3ba4-4cf5-8af2-a8d7b85087ac/devices/00000000-0000-0"
        },
        {
          "info": {
            "name": "getSiteDeviceSyntheticTest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/synthetic_test",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Device Synthetic Test"
        },
        {
          "info": {
            "name": "triggerSiteDeviceSyntheticTest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/synthetic_test",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Trigger Device Synthetic Test"
        },
        {
          "info": {
            "name": "triggerSiteSyntheticTest",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/synthetic_test",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Trigger Synthetic Testing"
        },
        {
          "info": {
            "name": "searchSiteSyntheticTest",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/synthetic_test/search",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "mac",
                "value": "",
                "type": "query",
                "description": "Filter results by MAC address"
              },
              {
                "name": "port_id",
                "value": "",
                "type": "query",
                "description": "Filter results by port identifier"
              },
              {
                "name": "vlan_id",
                "value": "",
                "type": "query",
                "description": "Filter results by VLAN ID"
              },
              {
                "name": "by",
                "value": "",
                "type": "query",
                "description": "Entity who triggers the test"
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "Filter results by reason"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Synthetic test type used to filter results. enum: `arp`, `curl`, `dhcp`, `dhcp6`, `dns`, `lan_connectivity`, `radius`, `speedtest`"
              },
              {
                "name": "protocol",
                "value": "",
                "type": "query",
                "description": "Connectivity protocol used to filter synthetic test results. enum: `ping`, `traceroute`"
              },
              {
                "name": "tenant",
                "value": "",
                "type": "query",
                "description": "Filter results by tenant network"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return per page"
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`"
              },
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`"
              },
              {
                "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 Site Synthetic Testing"
        }
      ]
    }
  ],
  "bundled": true
}