Skip to content
Cloudflare API
Start here
API Reference
Magic Transit

Cf1 Sites

List CF1 Sites
magic_transit.cf1_sites.list(Cf1SiteListParams**kwargs) -> SyncSinglePage[Cf1Site]
GET/accounts/{account_id}/magic/cf1_sites
Get CF1 Site
magic_transit.cf1_sites.get(strcf1_site_id, Cf1SiteGetParams**kwargs) -> Cf1Site
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Create CF1 Sites
magic_transit.cf1_sites.create(Cf1SiteCreateParams**kwargs) -> SyncSinglePage[Cf1Site]
POST/accounts/{account_id}/magic/cf1_sites
Update CF1 Site
magic_transit.cf1_sites.update(strcf1_site_id, Cf1SiteUpdateParams**kwargs) -> Cf1Site
PATCH/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Delete CF1 Site
magic_transit.cf1_sites.delete(strcf1_site_id, Cf1SiteDeleteParams**kwargs) -> Cf1Site
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
ModelsExpand Collapse
class Cf1Site: …
name: str

A human-provided name describing the CF1 Site that should be unique within the account.

id: Optional[str]

Identifier

maxLength32
created_on: Optional[datetime]
formatdate-time
description: Optional[str]

A human-provided description of the CF1 Site.

location: Optional[Cf1SiteLocation]
modified_on: Optional[datetime]
formatdate-time
class Cf1SiteLocation: …
lat: Optional[float]

Latitude of the CF1 Site.

formatfloat
long: Optional[float]

Longitude of the CF1 Site.

formatfloat
name: Optional[str]

Name of nearest town, city, or village.

Cf1 SitesRamps

List CF1 Site Ramps
magic_transit.cf1_sites.ramps.list(strcf1_site_id, RampListParams**kwargs) -> SyncSinglePage[Ramp]
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Get CF1 Site Ramp
magic_transit.cf1_sites.ramps.get(strramp_id, RampGetParams**kwargs) -> Ramp
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
Create CF1 Site Ramps
magic_transit.cf1_sites.ramps.create(strcf1_site_id, RampCreateParams**kwargs) -> SyncSinglePage[Ramp]
POST/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Delete CF1 Site Ramp
magic_transit.cf1_sites.ramps.delete(strramp_id, RampDeleteParams**kwargs) -> Ramp
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
ModelsExpand Collapse
class Ramp: …
id: str

Identifier

maxLength32
created_on: datetime
formatdate-time
modified_on: datetime
formatdate-time
name: str

A human-provided name describing the ramp that should be unique within the CF1 Site.

type: RampType

The type of network connection (ramp) linking a CF1 Site to Cloudflare’s network.

description: Optional[str]

A human-provided description of the ramp.

gre: Optional[GRE]
managed_by: Optional[str]

URL reference to the source network resource that this ramp is managed by.

gre_interconnect: Optional[GREInterconnect]
managed_by: Optional[str]

URL reference to the source network resource that this ramp is managed by.

ipsec: Optional[IPSEC]
managed_by: Optional[str]

URL reference to the source network resource that this ramp is managed by.

mconn: Optional[Mconn]
managed_by: Optional[str]

URL reference to the source network resource that this ramp is managed by.

mpls_interconnect: Optional[MplsInterconnect]
managed_by: Optional[str]

URL reference to the source network resource that this ramp is managed by.

Literal["gre", "gre_interconnect", "mpls_interconnect", 2 more]

The type of network connection (ramp) linking a CF1 Site to Cloudflare’s network.

One of the following:
"gre"
"gre_interconnect"
"mpls_interconnect"
"mconn"
"ipsec"