Add buckets for full packet captures

magic_transit.pcaps.ownership.create() -> Ownership

POST/accounts/{account_id}/pcaps/ownership

Adds an AWS or GCP bucket to use with full packet captures.

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

destination_conf: str

The full URI for the bucket. This field only applies to full packet captures.

ReturnsExpand Collapse

class Ownership: …

id: str

The bucket ID associated with the packet captures API.

maxLength32

minLength32

destination_conf: str

The full URI for the bucket. This field only applies to full packet captures.

filename: str

The ownership challenge filename stored in the bucket.

status: Literal["pending", "success", "failed"]

The status of the ownership challenge. Can be pending, success or failed.

One of the following:

"pending"

"success"

"failed"

submitted: str

The RFC 3339 timestamp when the bucket was added to packet captures API.

validated: Optional[str]

The RFC 3339 timestamp when the bucket was validated.

Add buckets for full packet captures

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
ownership = client.magic_transit.pcaps.ownership.create(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    destination_conf="s3://pcaps-bucket?region=us-east-1",
)
print(ownership.id)

{
  "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": "9883874ecac311ec8475433579a6bf5f",
    "destination_conf": "s3://pcaps-bucket?region=us-east-1",
    "filename": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
    "status": "success",
    "submitted": "2020-01-01T08:00:00Z",
    "validated": "2020-01-01T08:00:00Z"
  },
  "success": true
}

Returns Examples

{
  "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": "9883874ecac311ec8475433579a6bf5f",
    "destination_conf": "s3://pcaps-bucket?region=us-east-1",
    "filename": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt",
    "status": "success",
    "submitted": "2020-01-01T08:00:00Z",
    "validated": "2020-01-01T08:00:00Z"
  },
  "success": true
}