{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Utilities PCAPs API",
    "version": "2604.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Utilities PCAPs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "listOrgPacketCaptures",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/pcaps",
            "params": [
              {
                "name": "org_id",
                "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"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get List of Org Packet Captures"
        },
        {
          "info": {
            "name": "getOrgCapturingStatus",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/pcaps/capture",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Org Capturing status"
        },
        {
          "info": {
            "name": "startOrgPacketCapture",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/pcaps/capture",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a Packet Capture\n\n**NOTE**: For packet captures of org level Mist Edges only. Use [Start Site Packet Capture](/#operations/startSitePacketCapture) for site level Mist Edges. \n\nThe output will be available through websocket. As there can be multiple commands issued against the same AP 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\": \"/or"
        },
        {
          "info": {
            "name": "stopOrgPacketCapture",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/pcaps/capture",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Stop current Org capture"
        },
        {
          "info": {
            "name": "listSitePacketCaptures",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/pcaps",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "client_mac",
                "value": "",
                "type": "query",
                "description": "Optional client mac filter"
              },
              {
                "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"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get List of Site Packet Captures"
        },
        {
          "info": {
            "name": "getSiteCapturingStatus",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/sites/:site_id/pcaps/capture",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get Capturing status"
        },
        {
          "info": {
            "name": "startSitePacketCapture",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/sites/:site_id/pcaps/capture",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a Site Packet Capture\n\nThe output will be available through websocket. As there can be multiple commands issued against the same AP 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}/pcaps\"\n}\n```\n#### Response (MxEdge)\n```json\n{\n    \"event\": \"data\"\n    \"channel\": \"/sites/{site_id}/pcaps\"\n    \"data\": {\n         \"capture_i"
        },
        {
          "info": {
            "name": "stopSitePacketCapture",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/sites/:site_id/pcaps/capture",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Stop current capture"
        },
        {
          "info": {
            "name": "updateSitePacketCapture",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mist.com/api/v1/sites/:site_id/pcaps/:pcap_id",
            "params": [
              {
                "name": "site_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "pcap_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update or add notes to a completed packet capture"
        }
      ]
    }
  ],
  "bundled": true
}