v1

latestOpenAPI 3.0.0Proprietary2026-07-244990150.4 KB
Sessions

Get Session by ID

Returns a single session by its ID, including full session metadata and connection details.

get/v3/sessions/{session_id}

Path parameters

session_idstring required

The unique session identifier.

Query parameters

scope'workspace' | 'demo'

Controls the data scope for the query.

  • workspace: Query data from the current workspace (default). Requires the Sensors entitlement.
  • demo: Query demo/sample data. Requires the Swarm entitlement. Not available on export endpoints.

Response

OK - request successful.

_idstring

Unique session identifier.

firstPacketstring date-time

Timestamp of the first packet in the session.

lastPacketstring date-time

Timestamp of the last packet in the session.

source.ipstring

Source IP address.

source.portinteger

Source port number.

destination.ipstring

Destination IP address.

destination.portinteger

Destination port number.

source.bytesinteger

Total bytes sent from source.

source.packetsinteger

Total packets sent from source.

destination.bytesinteger

Total bytes sent from destination.

destination.packetsinteger

Total packets sent from destination.

classificationstring

GreyNoise classification of the source IP.

Example response

{
  "_id": "2505-abcdef123456",
  "firstPacket": "2025-01-15T10:30:00Z",
  "lastPacket": "2025-01-15T10:30:05Z",
  "source.ip": "203.0.113.45",
  "source.port": 54321,
  "destination.ip": "198.51.100.10",
  "destination.port": 443,
  "source.bytes": 1024,
  "source.packets": 10,
  "destination.bytes": 2048,
  "destination.packets": 8,
  "classification": "malicious"
}