Cloudflare API | Magic Transit

Updates a specific interconnect associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.cfInterconnects.bulkUpdate(, ):

CfInterconnectBulkUpdateResponse

put/accounts/{account_id}/magic/cf_interconnects

Updates multiple interconnects associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Magic Transit

Connectors

MagicTransit.Connectors

Methods

client.magicTransit.connectors.list(, ):

SinglePage

ConnectorListResponse

get/accounts/{account_id}/magic/connectors

List Connectors

client.magicTransit.connectors.get(, , ):

ConnectorGetResponse

get/accounts/{account_id}/magic/connectors/{connector_id}

Fetch Connector

client.magicTransit.connectors.create(, ):

ConnectorCreateResponse

post/accounts/{account_id}/magic/connectors

Add a connector to your account

client.magicTransit.connectors.update(, , ):

ConnectorUpdateResponse

put/accounts/{account_id}/magic/connectors/{connector_id}

Replace Connector or Re-provision License Key

client.magicTransit.connectors.edit(, , ):

ConnectorEditResponse

patch/accounts/{account_id}/magic/connectors/{connector_id}

Edit Connector to update specific properties or Re-provision License Key

client.magicTransit.connectors.delete(, , ):

ConnectorDeleteResponse

delete/accounts/{account_id}/magic/connectors/{connector_id}

Remove a connector from your account

Magic Transit Connectors

Events

MagicTransit.Connectors.Events

Methods

client.magicTransit.connectors.events.list(, , ):

EventListResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events

List Events

client.magicTransit.connectors.events.get(, , , , ):

EventGetResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/{event_t}.{event_n}

Get Event

Magic Transit Connectors Events

Latest

MagicTransit.Connectors.Events.Latest

Methods

client.magicTransit.connectors.events.latest.list(, , ):

LatestListResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/latest

Get latest Events

Magic Transit Connectors

Snapshots

MagicTransit.Connectors.Snapshots

Methods

client.magicTransit.connectors.snapshots.list(, , ):

SnapshotListResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots

List Snapshots

client.magicTransit.connectors.snapshots.get(, , , ):

SnapshotGetResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/{snapshot_t}

Get Snapshot

Magic Transit Connectors Snapshots

Latest

MagicTransit.Connectors.Snapshots.Latest

Methods

client.magicTransit.connectors.snapshots.latest.list(, , ):

LatestListResponse

get/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/latest

Get latest Snapshots

Magic Transit

GRE Tunnels

MagicTransit.GRETunnels

Methods

client.magicTransit.greTunnels.list(, ):

GRETunnelListResponse

get/accounts/{account_id}/magic/gre_tunnels

Lists GRE tunnels associated with an account.

client.magicTransit.greTunnels.get(, , ):

GRETunnelGetResponse

get/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Lists informtion for a specific GRE tunnel.

client.magicTransit.greTunnels.create(, ):

GRETunnelCreateResponse

post/accounts/{account_id}/magic/gre_tunnels

Creates a new GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.greTunnels.update(, , ):

GRETunnelUpdateResponse

put/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Updates a specific GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.greTunnels.delete(, , ):

GRETunnelDeleteResponse

delete/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}

Disables and removes a specific static GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.greTunnels.bulkUpdate(, ):

GRETunnelBulkUpdateResponse

put/accounts/{account_id}/magic/gre_tunnels

Updates multiple GRE tunnels. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Magic Transit

IPSEC Tunnels

MagicTransit.IPSECTunnels

Methods

client.magicTransit.ipsecTunnels.list(, ):

IPSECTunnelListResponse

get/accounts/{account_id}/magic/ipsec_tunnels

Lists IPsec tunnels associated with an account.

client.magicTransit.ipsecTunnels.get(, , ):

IPSECTunnelGetResponse

get/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Lists details for a specific IPsec tunnel.

client.magicTransit.ipsecTunnels.create(, ):

IPSECTunnelCreateResponse

post/accounts/{account_id}/magic/ipsec_tunnels

Creates a new IPsec tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.ipsecTunnels.update(, , ):

IPSECTunnelUpdateResponse

put/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Updates a specific IPsec tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.ipsecTunnels.delete(, , ):

IPSECTunnelDeleteResponse

delete/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}

Disables and removes a specific static IPsec Tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.ipsecTunnels.bulkUpdate(, ):

IPSECTunnelBulkUpdateResponse

put/accounts/{account_id}/magic/ipsec_tunnels

Update multiple IPsec tunnels associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

client.magicTransit.ipsecTunnels.pskGenerate(, , ):

IPSECTunnelPSKGenerateResponse

post/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate

Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.

Domain types

PSKMetadata{…}

The PSK metadata that includes when the PSK was generated.

Magic Transit

PCAPs

MagicTransit.PCAPs

Methods

client.magicTransit.pcaps.list(, ):

SinglePage

PCAPListResponse

get/accounts/{account_id}/pcaps

Lists all packet capture requests for an account.

client.magicTransit.pcaps.get(, , ):

PCAPGetResponse

get/accounts/{account_id}/pcaps/{pcap_id}

Get information for a PCAP request by id.

client.magicTransit.pcaps.create(, ):

PCAPCreateResponse

post/accounts/{account_id}/pcaps

Create new PCAP request for account.

client.magicTransit.pcaps.stop(, , ): void

put/accounts/{account_id}/pcaps/{pcap_id}/stop

Stop full PCAP.

Domain types

PCAP{…}

PCAPFilter{…}

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

Magic Transit PCAPs

Download

MagicTransit.PCAPs.Download

Methods

client.magicTransit.pcaps.download.get(, , ):

Response

get/accounts/{account_id}/pcaps/{pcap_id}/download

Download PCAP information into a file. Response is a binary PCAP file.

Magic Transit PCAPs

Ownership

MagicTransit.PCAPs.OwnershipResource

Methods

client.magicTransit.pcaps.ownership.get(, ):

SinglePage

Ownership

get/accounts/{account_id}/pcaps/ownership

List all buckets configured for use with PCAPs API.

client.magicTransit.pcaps.ownership.create(, ):

Ownership

post/accounts/{account_id}/pcaps/ownership

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

client.magicTransit.pcaps.ownership.delete(, , ): void

delete/accounts/{account_id}/pcaps/ownership/{ownership_id}

Deletes buckets added to the packet captures API.

client.magicTransit.pcaps.ownership.validate(, ):

Ownership

post/accounts/{account_id}/pcaps/ownership/validate

Validates buckets added to the packet captures API.

Domain types

Ownership{…}

Magic Transit

Routes

MagicTransit.Routes

Methods

client.magicTransit.routes.list(, ):

RouteListResponse

get/accounts/{account_id}/magic/routes

List all Magic static routes.

client.magicTransit.routes.get(, , ):

RouteGetResponse

get/accounts/{account_id}/magic/routes/{route_id}

Get a specific Magic static route.

client.magicTransit.routes.create(, ):

RouteCreateResponse

post/accounts/{account_id}/magic/routes

Creates a new Magic static route. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes.

client.magicTransit.routes.update(, , ):

RouteUpdateResponse

put/accounts/{account_id}/magic/routes/{route_id}

Update a specific Magic static route. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes.

client.magicTransit.routes.delete(, , ):

RouteDeleteResponse

delete/accounts/{account_id}/magic/routes/{route_id}

Disable and remove a specific Magic static route.

client.magicTransit.routes.bulkUpdate(, ):

RouteBulkUpdateResponse

put/accounts/{account_id}/magic/routes

Update multiple Magic static routes. Use ?validate_only=true as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.

client.magicTransit.routes.empty(, ):

RouteEmptyResponse

delete/accounts/{account_id}/magic/routes

Delete multiple Magic static routes.

Domain types

Scope{…}

Used only for ECMP routes.

Magic Transit

Sites

MagicTransit.Sites

Methods

client.magicTransit.sites.list(, ):

SinglePage

Site

get/accounts/{account_id}/magic/sites

Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.

client.magicTransit.sites.get(, , ):

Site

get/accounts/{account_id}/magic/sites/{site_id}

Get a specific Site.

client.magicTransit.sites.create(, ):

Site

post/accounts/{account_id}/magic/sites

Creates a new Site

client.magicTransit.sites.update(, , ):

Site

put/accounts/{account_id}/magic/sites/{site_id}

Update a specific Site.

client.magicTransit.sites.edit(, , ):

Site

patch/accounts/{account_id}/magic/sites/{site_id}

Patch a specific Site.

client.magicTransit.sites.delete(, , ):

Site

delete/accounts/{account_id}/magic/sites/{site_id}

Remove a specific Site.

Domain types

Site{…}

SiteLocation{…}

Location of site in latitude and longitude.

Magic Transit Sites

ACLs

MagicTransit.Sites.ACLs

Methods

client.magicTransit.sites.acls.list(, , ):

SinglePage

ACL

get/accounts/{account_id}/magic/sites/{site_id}/acls

Lists Site ACLs associated with an account.

client.magicTransit.sites.acls.get(, , , ):

ACL

get/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Get a specific Site ACL.

client.magicTransit.sites.acls.create(, , ):

ACL

post/accounts/{account_id}/magic/sites/{site_id}/acls

Creates a new Site ACL.

client.magicTransit.sites.acls.update(, , , ):

ACL

put/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Update a specific Site ACL.

client.magicTransit.sites.acls.edit(, , , ):

ACL

patch/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Patch a specific Site ACL.

client.magicTransit.sites.acls.delete(, , , ):

ACL

delete/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}

Remove a specific Site ACL.

Domain types

ACL{…}

Bidirectional ACL policy for network traffic within a site.

ACLConfiguration{…}

AllowedProtocol = "tcp" | "udp" | "icmp"

Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.

Subnet = string

A valid IPv4 address.

Magic Transit Sites

LANs

MagicTransit.Sites.LANs

Methods

client.magicTransit.sites.lans.list(, , ):

SinglePage

LAN

get/accounts/{account_id}/magic/sites/{site_id}/lans

Lists Site LANs associated with an account.

client.magicTransit.sites.lans.get(, , , ):

LAN

get/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Get a specific Site LAN.

client.magicTransit.sites.lans.create(, , ):

SinglePage

LAN

post/accounts/{account_id}/magic/sites/{site_id}/lans

Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.

client.magicTransit.sites.lans.update(, , , ):

LAN

put/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Update a specific Site LAN.

client.magicTransit.sites.lans.edit(, , , ):

LAN

patch/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Patch a specific Site LAN.

client.magicTransit.sites.lans.delete(, , , ):

LAN

delete/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}

Remove a specific Site LAN.

Domain types

DHCPRelay{…}

DHCPServer{…}

LAN{…}

LANStaticAddressing{…}

If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.

Nat{…}

RoutedSubnet{…}

Magic Transit Sites