--- title: Create PCAP request --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Magic Transit](https://developers.cloudflare.com/api/python/resources/magic_transit) [PCAPs](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/pcaps) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create PCAP request magic\_transit.pcaps.create(PCAPCreateParams\*\*kwargs) -> [PCAPCreateResponse]() 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 account\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>) packet\_limit: float The limit of packets contained in a packet capture. maximum10000 minimum1 [Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20packet_limit%20%3E%20(schema)>) system: Literal\["magic-transit"] The system used to collect packet captures. [Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20system%20%3E%20(schema)>) time\_limit: float The packet capture duration in seconds. maximum300 minimum1 [Link to this property](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20time_limit%20%3E%20(schema)>)
type: 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](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20type%20%3E%20(schema)>)
filter\_v1: Optional\[PCAPFilterParam] 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(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20filter_v1%20%3E%20(schema)>) offset\_time: Optional\[Union\[str, 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](<#(resource)%20magic_transit.pcaps%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20offset_time%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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. 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 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. 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 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)>) ### Create PCAP request Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) pcap = client.magic_transit.pcaps.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", packet_limit=10000, system="magic-transit", time_limit=300, type="simple", ) print(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 } ```