--- title: Create PCAP request --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Magic Transit](https://developers.cloudflare.com/api/go/resources/magic_transit) [PCAPs](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/pcaps) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create PCAP request client.MagicTransit.PCAPs.New(ctx, params) (\*[PCAPNewResponse](), error) POST/accounts/{account\_id}/pcaps Create new PCAP request for account. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Magic Firewall Packet Captures - Write PCAPs API` ##### ParametersExpand Collapse

params PCAPNewParams

AccountID param.Field\[string] Path param: Identifier. maxLength32 Link to this property PacketLimit param.Field\[float64] Body param: The limit of packets contained in a packet capture. maximum10000 minimum1 Link to this property

System param.Field\[PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleSystem] Body param: The system used to collect packet captures.

const PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleSystemMagicTransit PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleSystem = "magic-transit" Link to this property

Link to this property TimeLimit param.Field\[float64] Body param: The packet capture duration in seconds. maximum300 minimum1 Link to this property

Type param.Field\[PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleType] Body param: The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets.

const PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleTypeSimple PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleType = "simple" Link to this property const PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleTypeFull PCAPNewParamsMagicVisibilityPCAPsPCAPsRequestSimpleType = "full" Link to this property

Link to this property FilterV1 param.Field\[PCAPFilter]Optional Body param: The packet capture filter. When this field is empty, all packets are captured. Link to this property OffsetTime param.Field\[Time]Optional Body param: The RFC 3339 offset timestamp from which to query backwards for packets. Must be within the last 24h. When this field is empty, defaults to time of request. formatdate-time Link to this property

[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200>) ##### ReturnsExpand Collapse

type PCAPNewResponse interface{…}

One of the following:

type PCAP struct{…}

ID stringOptional The ID for the packet capture. maxLength32 minLength32 Link to this property

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

DestinationAddress stringOptional The destination IP address of the packet. Link to this property DestinationPort float64Optional The destination port of the packet. Link to this property Protocol float64Optional The protocol number of the packet. Link to this property SourceAddress stringOptional The source IP address of the packet. Link to this property SourcePort float64Optional The source port of the packet. Link to this property

Link to this property OffsetTime TimeOptional The RFC 3339 offset timestamp from which to query backwards for packets. Must be within the last 24h. When this field is empty, defaults to time of request. formatdate-time Link to this property

Status PCAPStatusOptional The status of the packet capture request.

One of the following: const PCAPStatusUnknown PCAPStatus = "unknown" Link to this property const PCAPStatusSuccess PCAPStatus = "success" Link to this property const PCAPStatusPending PCAPStatus = "pending" Link to this property const PCAPStatusRunning PCAPStatus = "running" Link to this property const PCAPStatusConversionPending PCAPStatus = "conversion\_pending" Link to this property const PCAPStatusConversionRunning PCAPStatus = "conversion\_running" Link to this property const PCAPStatusComplete PCAPStatus = "complete" Link to this property const PCAPStatusFailed PCAPStatus = "failed" Link to this property

Link to this property Submitted stringOptional The RFC 3339 timestamp when the packet capture was created. Link to this property System PCAPSystemOptional The system used to collect packet captures. Link to this property TimeLimit float64Optional The packet capture duration in seconds. maximum300 minimum1 Link to this property

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

One of the following: const PCAPTypeSimple PCAPType = "simple" Link to this property const PCAPTypeFull PCAPType = "full" Link to this property

Link to this property

type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull struct{…}

ID stringOptional The ID for the packet capture. maxLength32 minLength32 Link to this property ByteLimit float64Optional The maximum number of bytes to capture. This field only applies to full packet captures. maximum1000000000 minimum1 Link to this property ColoName stringOptional The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to full packet captures. Link to this property DestinationConf stringOptional The full URI for the bucket. This field only applies to full packet captures. Link to this property ErrorMessage stringOptional An error message that describes why the packet capture failed. This field only applies to full packet captures. Link to this property

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

Link to this property PacketsCaptured int64Optional The number of packets captured. Link to this property

Status PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusOptional The status of the packet capture request.

One of the following: const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknown PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccess PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPending PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunning PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPending PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion\_pending" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunning PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion\_running" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusComplete PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailed PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed" Link to this property

Link to this property StopRequested TimeOptional The RFC 3339 timestamp when stopping the packet capture was requested. This field only applies to full packet captures. formatdate-time Link to this property Submitted stringOptional The RFC 3339 timestamp when the packet capture was created. Link to this property System PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystemOptional The system used to collect packet captures. Link to this property TimeLimit float64Optional The packet capture duration in seconds. maximum86400 minimum1 Link to this property

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

One of the following: const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimple PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple" Link to this property const PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFull PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full" Link to this property

Link to this property

[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(model)%20PCAPNewResponse%20%3E%20(schema)>) ### Create PCAP request Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/magic_transit" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) pcap, err := client.MagicTransit.PCAPs.New(context.TODO(), magic_transit.PCAPNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Body: magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple{ PacketLimit: cloudflare.F(10000.000000), System: cloudflare.F(magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystemMagicTransit), TimeLimit: cloudflare.F(300.000000), Type: cloudflare.F(magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypeSimple), }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", pcap) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "66802ca5668e47a2b82c2e6746e45037", "filter_v1": { "destination_address": "1.2.3.4", "destination_port": 80, "protocol": 6, "source_address": "1.2.3.4", "source_port": 123 }, "offset_time": "2020-01-01T08:00:00Z", "status": "success", "submitted": "2020-01-01T08:00:00Z", "system": "magic-transit", "time_limit": 300, "type": "simple" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "66802ca5668e47a2b82c2e6746e45037", "filter_v1": { "destination_address": "1.2.3.4", "destination_port": 80, "protocol": 6, "source_address": "1.2.3.4", "source_port": 123 }, "offset_time": "2020-01-01T08:00:00Z", "status": "success", "submitted": "2020-01-01T08:00:00Z", "system": "magic-transit", "time_limit": 300, "type": "simple" }, "success": true } ```