{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Utilities LAN API",
    "version": "2604.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Utilities LAN",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "reauthOrgDot1xWiredClient",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/wired_clients/:client_mac/coa",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "client_mac",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Trigger a CoA (change of authorization) against a Wired client"
        },
        {
          "info": {
            "name": "clearSiteMultipleDevicePendingVersion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/clear_pending_version",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)"
        },
        {
          "info": {
            "name": "restoreSiteMultipleDeviceBackupVersion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/restore_backup_version",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)"
        },
        {
          "info": {
            "name": "upgradeSiteDevicesBios",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade_bios",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upgrade Bios on Multiple Device"
        },
        {
          "info": {
            "name": "upgradeSiteDevicesFpga",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/upgrade_fpga",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upgrade Bios on Multiple Device"
        },
        {
          "info": {
            "name": "cableTestFromSwitch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/cable_test",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "TDR can be performed from the Switch. The output will be available through websocket. As there can be multiple commands issued against the same Switch at the same time and the output all goes through the same websocket stream, session is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n##### Example output from ws stream\n```json\n{\n    \"event\": \"data\",\n    \"channel\": \"/sites/4ac1dcf4"
        },
        {
          "info": {
            "name": "clearBpduErrorsFromPortsOnSwitch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_bpdu_error",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clear bridge protocol data unit (BPDU) error condition caused by the detection of a possible bridging loop from Spanning Tree Protocol (STP) operation that renders the port unoperational."
        },
        {
          "info": {
            "name": "clearSiteDeviceDot1xSession",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_dot1x",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clear Dot1x Session. The output will be available through websocket."
        },
        {
          "info": {
            "name": "clearAllLearnedMacsFromPortOnSwitch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_macs",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Clear all learned MAC addresses, including persistent MAC addresses, on a port."
        },
        {
          "info": {
            "name": "clearSiteDevicePendingVersion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/clear_pending_version",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Clear device pending fw version (Available on Junos OS EX2300-, EX3400-, EX4000-, EX4100-, EX4400- devices)"
        },
        {
          "info": {
            "name": "pollSiteSwitchStats",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/poll_stats",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API can be used to poll statistics from the Switch proactively once. After it is called, the statistics will be pushed back to the cloud within the statistics interval."
        },
        {
          "info": {
            "name": "restoreSiteDeviceBackupVersion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/restore_backup_version",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Restore device backup fw version (Available on Junos OS EX4000-, EX4100-, EX4400- devices)"
        },
        {
          "info": {
            "name": "showSiteDeviceArpTable",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/show_arp",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get ARP Table from the Device.\n\nThe output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux.\n\n#### Subscribe to Device Command outputs\n`WS /api-ws/v1/stream`\n\n```json\n{\n    \"subscribe\": \"/sites/{site_id}/devices/{device_id}/cmd\"\n}\n```\n"
        },
        {
          "info": {
            "name": "createSiteDeviceSnapshot",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/snapshot",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Create recovery device snapshot (Available on Junos OS EX2300-, EX3400-, EX4400- devices)"
        },
        {
          "info": {
            "name": "upgradeDeviceBios",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/upgrade_bios",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upgrade device bios"
        },
        {
          "info": {
            "name": "upgradeDeviceFPGA",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/upgrade_fpga",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Upgrade device fpga"
        },
        {
          "info": {
            "name": "toogleSiteDeviceVcRoutingEnginesRole",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/devices/:device_id/vc/switch_master",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "device_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "In a pre-provisioned VC, mastership is system-determined. This command allows manual toggling between primary and backup Routing Engines."
        },
        {
          "info": {
            "name": "reauthSiteDot1xWiredClient",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/wired_clients/:client_mac/coa",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "client_mac",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Trigger a CoA (change of authorization) against a Wired client"
        }
      ]
    }
  ],
  "bundled": true
}