Skip to main content

Search PCAP payload

GET
/files/{id}/pcap-search

Contract

Parameter
Value
Sectionfiles
AuthenticationCookieAuth
Consumesnot required
Producesapplication/json

Parameters

4 parameters

Name
Location
Required
Type
Description
idpathyesintegerFile ID
clientIpqueryyesstringClient IP whose sessions should be searched
queryqueryyesstringSearch pattern (interpretation depends on the mode)
modequerynoenum(text, hex, regex)Match mode
  • "text"

Responses

5 responses

Status
Description
Type
200
Search result: {query, mode, totalCount, matches[]}object
400
Invalid file ID, missing query/clientIp, or invalid hex/regex patternobject
401
Unauthorizedobject
404
File not foundobject
500
Failed to read fileobject
  • {
      "cursor": {
        "count": 0,
        "currentPage": 0,
        "totalPages": 0,
        "totalRows": 0
      },
      "data": {}
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }