Create PCAP request

POST

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/pcaps

Last modified:2022-12-16 13:48:33

Create new PCAP request for account.

Request

Path Params

account_identifier

string

required

Body Params application/json

pcaps_request_pcap

optional

Any of

pcaps_request_simple

pcaps_request_full

filter_v1

object

pcaps_filter_v1

optional

The packet capture filter. When this field is empty, all packets are captured.

packet_limit

number

pcaps_packet_limit

required

The limit of packets contained in a packet capture.

>= 1<= 10000

Example:

10000

system

enum<string>

pcaps_system

required

The system used to collect packet captures.

Allowed value:

magic-transit

Example:

magic-transit

time_limit

number

pcaps_time_limit

required

The packet capture duration in seconds.

>= 1<= 300

Example:

300

type

enum<string>

pcaps_type

required

The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets.

Allowed values:

simplefull

Example:

simple

Example

{
    "filter_v1": {
        "destination_address": "1.2.3.4",
        "destination_port": 80,
        "protocol": 6,
        "source_address": "1.2.3.4",
        "source_port": 123
    },
    "packet_limit": 10000,
    "system": "magic-transit",
    "time_limit": 300,
    "type": "simple"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/accounts//pcaps' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filter_v1": {
        "destination_address": "1.2.3.4",
        "destination_port": 80,
        "protocol": 6,
        "source_address": "1.2.3.4",
        "source_port": 123
    },
    "packet_limit": 10000,
    "system": "magic-transit",
    "time_limit": 300,
    "type": "simple"
}'

Responses

🟢200Create PCAP request response

application/json

Body

result

required

Any of

allOf {2}

One of

null

pcaps_response_simple

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "filter_v1": {
            "destination_address": "1.2.3.4",
            "destination_port": 80,
            "protocol": 6,
            "source_address": "1.2.3.4",
            "source_port": 123
        },
        "id": "66802ca5668e47a2b82c2e6746e45037",
        "status": "success",
        "submitted": "2020-01-01T08:00:00Z",
        "system": "magic-transit",
        "time_limit": 300,
        "type": "simple"
    },
    "success": true
}

🟢200Create PCAP request response failure

Modified at 2022-12-16 13:48:33

List packet capture requests

List PCAPs Bucket Ownership