ONoneuptime
Packet Capture

Get Packet Capture

Endpoint to retrieve a single Packet Capture by ID

post/packet-capture/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Packet Capture to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "interfaceName": true,
    "status": true,
    "endReason": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "probeId": "123e4567-e89b-12d3-a456-426614174000",
    "networkDeviceId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "eth0: host 10.0.0.5",
    "interfaceName": "eth0",
    "bpfFilter": "host 10.0.0.5 and tcp port 443",
    "maxDurationInSeconds": 42,
    "maxPackets": 42,
    "maxFileSizeInMB": 42,
    "status": "Pending",
    "statusMessage": "This is an example of longer text content that might be stored in this field.",
    "endReason": "DurationReached",
    "startedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "completedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "stopRequestedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "packetCount": 42,
    "fileSizeInBytes": 42,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.