Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
UtilitiesPCAPs

listOrgPacketCaptures

GET
/api/v1/orgs/{org_id}/pcaps

List organization packet capture sessions and generated capture files for the selected time range.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/pcaps"
{  "end": 1461089816,  "limit": 100,  "next": "/api/v1/sites/67970e46-4e12-11e6-9188-0242ac110007/pcaps?start=1461099816&search_after=%5B1694537121217%5D&limit=100&end=1461089816",  "results": [    {      "ap_macs": [        "5c5b35000010"      ],      "timestamp": 1461869041,      "type": "new_assoc",      "url": "https://..."    },    {      "duration": 9999,      "format": "stream",      "id": "80cec4c9-322c-4712-95ce-6ba47fb54fc0",      "last_seen": 1693482149.417,      "mxedges": [        "00000000-0000-0000-1000-001122334455"      ],      "org_id": "78c11da8-f984-4425-bedb-a7ddd7d0f6da",      "pcap_url": "https://...",      "site_id": null,      "termination_reason": "default",      "timestamp": 1693525333.234066,      "type": "mxedge",      "url": "https://..."    }  ],  "start": 1461099816}

stopSiteFlowCapture DELETE

Stop the active flow capture session for the site. Returns 400 if no flow capture session is active.

listSitePacketCaptures GET

List packet captures for a site, optionally filtered by client MAC address and time range. Use [List Org Packet Captures](/api/mist/utilities/utilities-pcaps/listOrgPacketCaptures) to retrieve packet captures across the organization.