--- title: List packet capture requests --- [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** # List packet capture requests client.MagicTransit.PCAPs.List(ctx, query) (\*SinglePage\[[PCAPListResponse]()], error) GET/accounts/{account\_id}/pcaps Lists all packet capture requests for an 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``Magic Firewall Packet Captures - Read PCAPs API` ##### ParametersExpand Collapse
query PCAPListParams AccountID param.Field\[string] Identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type PCAPListResponse 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
Link to this property
type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull 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. 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 PacketsCaptured int64Optional The number of packets captured. Link to this property
Status PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusOptional The status of the packet capture request. One of the following: const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknown PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccess PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPending PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunning PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPending PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion\_pending" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunning PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion\_running" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusComplete PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailed PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "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 PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystemOptional 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 PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeOptional The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimple PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple" Link to this property const PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFull PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(model)%20PCAPListResponse%20%3E%20(schema)>) ### List packet capture requests 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"), ) page, err := client.MagicTransit.PCAPs.List(context.TODO(), magic_transit.PCAPListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### 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, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```