Packet Capture

Create Packet Capture

Endpoint to create a new Packet Capture

post/packet-capture

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "probeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "interfaceName": "Example Text"
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "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"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "probe": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "probeId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "networkDevice": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "networkDeviceId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "interfaceName": "Example Text",
    "bpfFilter": "This is an example of longer text content that provides detailed information.",
    "maxDurationInSeconds": 42,
    "maxPackets": 42,
    "maxFileSizeInMB": 42,
    "status": "Example Text",
    "statusMessage": "This is an example of longer text content that provides detailed information.",
    "endReason": "Example Text",
    "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,
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

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