API docs by Redocly

QA | Cloudshark PV (2.0.0)

Download OpenAPI specification:

Packet analysis API for PCAP files.

Health

Check health of API

Responses

Response samples

Content type
application/json
{
  • "healthy": true
}

Assets

Static world map

Responses

Response samples

Content type
application/json
{
  • "map": "..."
}

File

Returns information about a currently loaded file

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Packets

Return a list of packets with the specified columns

query Parameters
filter
string
Default: ""

a display filter to apply to the returned list of packets

start
number <uint32>
Default: 0
count
number <uint32>
Default: 1000

The number of packets to return

columns
Array of strings
Default: ""

A comma separated list of packet fields to return the data for

Responses

Return an array of packets with the specified fields returned in a map

query Parameters
filter
string
Default: ""

a display filter to apply to the returned list of packets

start
number <uint32>
Default: 0
count
number <uint32>
Default: 1000

The number of packets to return

fields
Array of strings
Default: ""

A comma separated list of up to 32 fields to return

Responses

Return the full packet tree and raw bytes of the requested packet

query Parameters
frame
required
number <uint32> >= 1
prev_frame
number <uint32>

Responses

Util

tests a display filter to see if it is valid

query Parameters
f
required
string

the display filter string to tests

Responses

get autocomplete suggestions for the provided field or preference

query Parameters
field
string

a partial or complete field string to perform autocompelete on

preference
string

a partial or complete preference string to perform autocomplete on

Responses

Follow

Follow Stream data for the specified protocol and filter expression

path Parameters
protocol
required
string
query Parameters
filter
required
string
sub_stream
number <uint64>

Responses

Stats

List conversation stats for the given protocol

query Parameters
protocol
required
string

Responses

List of DNS stats for file

query Parameters
filter
string

Responses

List all endpoints for a given protocol

query Parameters
protocol
required
string

Responses

The protocol hierarchy tree

Responses

List conversation stats

query Parameters
filter
string

Responses

RTP

List of RTP streams found in the file

Responses

Retrieve WAV audio of the specified RTP stream

query Parameters
source
required
string

The source IP address of the RTP stream

source_port
required
number <uint>

The source port of the RTP stream

dest
required
string

The destination IP address of the RTP stream

dest_port
required
number <uint>

the destination port of the RTP stream

ssrc
required
string

The SSRC identifying the RTP stream

Responses

HTTP

Summary list of HTTP requests made within the file grouped by host

Responses

List the available HTTP Objects from the file

Responses

Download the raw bytes for the given HTTP Object token

path Parameters
token
required
string

Responses

Detailed list of HTTP requests and responses from the file

query Parameters
filter
string
Default: ""

an optional display filter to limit the HTTP Request data

Responses

Hosts

A list of resolved hostnames contained in the file

Responses

VOIP

A list of the VoIP calls contained in the file

Responses

VoIP conversation records including SIP signaling and RTP streams

query Parameters
callid
number <integer>
Default: -1

A call or conversation identifier with -1 corresponding to 'all calls'

Responses

DNS

A list of DNS lookups found in the file including queries without responses and responses without queries

query Parameters
filter
string
Default: ""

an optional additional display filter to further limit the DNS lookup data

Responses