--- title: PCAPs --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Magic Transit](https://developers.cloudflare.com/api/python/resources/magic_transit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # PCAPs ##### [List packet capture requests](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/methods/list) magic\_transit.pcaps.list(PCAPListParams\*\*kwargs) -> SyncSinglePage\[[PCAPListResponse]()] GET/accounts/{account\_id}/pcaps ##### [Get PCAP request](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/methods/get) magic\_transit.pcaps.get(strpcap\_id, PCAPGetParams\*\*kwargs) -> [PCAPGetResponse]() GET/accounts/{account\_id}/pcaps/{pcap\_id} ##### [Create PCAP request](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/methods/create) magic\_transit.pcaps.create(PCAPCreateParams\*\*kwargs) -> [PCAPCreateResponse]() POST/accounts/{account\_id}/pcaps ##### [Stop full PCAP](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/methods/stop) magic\_transit.pcaps.stop(strpcap\_id, PCAPStopParams\*\*kwargs) PUT/accounts/{account\_id}/pcaps/{pcap\_id}/stop ##### ModelsExpand Collapse
class PCAP: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property offset\_time: Optional\[datetime] 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: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property submitted: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum300 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "full" Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(model)%20pcap%20%3E%20(schema)>)
class PCAPFilter: … The packet capture filter. When this field is empty, all packets are captured. destination\_address: Optional\[str] The destination IP address of the packet. Link to this property destination\_port: Optional\[float] The destination port of the packet. Link to this property protocol: Optional\[float] The protocol number of the packet. Link to this property source\_address: Optional\[str] The source IP address of the packet. Link to this property source\_port: Optional\[float] The source port of the packet. Link to this property
[Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(model)%20pcap_filter%20%3E%20(schema)>)
PCAPListResponse One of the following:
class PCAP: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property offset\_time: Optional\[datetime] 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: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property submitted: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum300 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "full" Link to this property
Link to this property
Link to this property
class MagicVisibilityPCAPsPCAPsResponseFull: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property byte\_limit: Optional\[float] The maximum number of bytes to capture. This field only applies to full packet captures. maximum1000000000 minimum1 Link to this property colo\_name: Optional\[str] 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 destination\_conf: Optional\[str] The full URI for the bucket. This field only applies to full packet captures. Link to this property error\_message: Optional\[str] An error message that describes why the packet capture failed. This field only applies to full packet captures. Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property packets\_captured: Optional\[int] The number of packets captured. Link to this property
status: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property stop\_requested: Optional\[datetime] 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: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum86400 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "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)%20pcap_list_response%20%3E%20(schema)>)
PCAPGetResponse One of the following:
class PCAP: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property offset\_time: Optional\[datetime] 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: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property submitted: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum300 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "full" Link to this property
Link to this property
Link to this property
class MagicVisibilityPCAPsPCAPsResponseFull: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property byte\_limit: Optional\[float] The maximum number of bytes to capture. This field only applies to full packet captures. maximum1000000000 minimum1 Link to this property colo\_name: Optional\[str] 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 destination\_conf: Optional\[str] The full URI for the bucket. This field only applies to full packet captures. Link to this property error\_message: Optional\[str] An error message that describes why the packet capture failed. This field only applies to full packet captures. Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property packets\_captured: Optional\[int] The number of packets captured. Link to this property
status: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property stop\_requested: Optional\[datetime] 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: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum86400 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "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)%20pcap_get_response%20%3E%20(schema)>)
PCAPCreateResponse One of the following:
class PCAP: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property offset\_time: Optional\[datetime] 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: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property submitted: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum300 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "full" Link to this property
Link to this property
Link to this property
class MagicVisibilityPCAPsPCAPsResponseFull: … id: Optional\[str] The ID for the packet capture. maxLength32 minLength32 Link to this property byte\_limit: Optional\[float] The maximum number of bytes to capture. This field only applies to full packet captures. maximum1000000000 minimum1 Link to this property colo\_name: Optional\[str] 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 destination\_conf: Optional\[str] The full URI for the bucket. This field only applies to full packet captures. Link to this property error\_message: Optional\[str] An error message that describes why the packet capture failed. This field only applies to full packet captures. Link to this property filter\_v1: Optional\[PCAPFilter] The packet capture filter. When this field is empty, all packets are captured. Link to this property packets\_captured: Optional\[int] The number of packets captured. Link to this property
status: Optional\[Literal\["unknown", "success", "pending", 5 more]] The status of the packet capture request. One of the following: "unknown" Link to this property "success" Link to this property "pending" Link to this property "running" Link to this property "conversion\_pending" Link to this property "conversion\_running" Link to this property "complete" Link to this property "failed" Link to this property
Link to this property stop\_requested: Optional\[datetime] 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: Optional\[str] The RFC 3339 timestamp when the packet capture was created. Link to this property system: Optional\[Literal\["magic-transit"]] The system used to collect packet captures. Link to this property time\_limit: Optional\[float] The packet capture duration in seconds. maximum86400 minimum1 Link to this property
type: Optional\[Literal\["simple", "full"]] The type of packet capture. Simple captures sampled packets, and full captures entire payloads and non-sampled packets. One of the following: "simple" Link to this property "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)%20pcap_create_response%20%3E%20(schema)>) #### PCAPsOwnership ##### [List PCAPs Bucket Ownership](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/get) magic\_transit.pcaps.ownership.get(OwnershipGetParams\*\*kwargs) -> SyncSinglePage\[[Ownership]()] GET/accounts/{account\_id}/pcaps/ownership ##### [Add buckets for full packet captures](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/create) magic\_transit.pcaps.ownership.create(OwnershipCreateParams\*\*kwargs) -> [Ownership]() POST/accounts/{account\_id}/pcaps/ownership ##### [Delete buckets for full packet captures](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/delete) magic\_transit.pcaps.ownership.delete(strownership\_id, OwnershipDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/pcaps/ownership/{ownership\_id} ##### [Validate buckets for full packet captures](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/validate) magic\_transit.pcaps.ownership.validate(OwnershipValidateParams\*\*kwargs) -> [Ownership]() POST/accounts/{account\_id}/pcaps/ownership/validate ##### ModelsExpand Collapse
class Ownership: … id: str The bucket ID associated with the packet captures API. maxLength32 minLength32 Link to this property destination\_conf: str The full URI for the bucket. This field only applies to full packet captures. Link to this property filename: str The ownership challenge filename stored in the bucket. Link to this property
status: Literal\["pending", "success", "failed"] The status of the ownership challenge. Can be pending, success or failed. One of the following: "pending" Link to this property "success" Link to this property "failed" Link to this property
Link to this property submitted: str The RFC 3339 timestamp when the bucket was added to packet captures API. Link to this property validated: Optional\[str] The RFC 3339 timestamp when the bucket was validated. Link to this property
[Link to this property](<#(resource)%20magic_transit.pcaps.ownership%20%3E%20(model)%20ownership%20%3E%20(schema)>) #### PCAPsDownload ##### [Download Simple PCAP](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps/subresources/download/methods/get) magic\_transit.pcaps.download.get(strpcap\_id, DownloadGetParams\*\*kwargs) -> BinaryResponseContent GET/accounts/{account\_id}/pcaps/{pcap\_id}/download