Skip to content
Cloudflare API
Start here
API Reference
Magic Transit

Cf1 Sites

List CF1 Sites
client.magicTransit.cf1Sites.list(Cf1SiteListParams { account_id } params, RequestOptionsoptions?): SinglePage<Cf1Site { name, id, created_on, 3 more } >
GET/accounts/{account_id}/magic/cf1_sites
Get CF1 Site
client.magicTransit.cf1Sites.get(stringcf1SiteId, Cf1SiteGetParams { account_id } params, RequestOptionsoptions?): Cf1Site { name, id, created_on, 3 more }
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Create CF1 Sites
client.magicTransit.cf1Sites.create(Cf1SiteCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<Cf1Site { name, id, created_on, 3 more } >
POST/accounts/{account_id}/magic/cf1_sites
Update CF1 Site
client.magicTransit.cf1Sites.update(stringcf1SiteId, Cf1SiteUpdateParams { account_id, description, location, name } params, RequestOptionsoptions?): Cf1Site { name, id, created_on, 3 more }
PATCH/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Delete CF1 Site
client.magicTransit.cf1Sites.delete(stringcf1SiteId, Cf1SiteDeleteParams { account_id } params, RequestOptionsoptions?): Cf1Site { name, id, created_on, 3 more }
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
ModelsExpand Collapse
Cf1Site { name, id, created_on, 3 more }
name: string

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

id?: string

Identifier

maxLength32
created_on?: string
formatdate-time
description?: string

A human-provided description of the CF1 Site.

location?: Cf1SiteLocation { lat, long, name }
modified_on?: string
formatdate-time
Cf1SiteLocation { lat, long, name }
lat?: number

Latitude of the CF1 Site.

formatfloat
long?: number

Longitude of the CF1 Site.

formatfloat
name?: string

Name of nearest town, city, or village.

Cf1 SitesRamps

List CF1 Site Ramps
client.magicTransit.cf1Sites.ramps.list(stringcf1SiteId, RampListParams { account_id } params, RequestOptionsoptions?): SinglePage<Ramp { id, created_on, modified_on, 8 more } >
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Get CF1 Site Ramp
client.magicTransit.cf1Sites.ramps.get(stringcf1SiteId, stringrampId, RampGetParams { account_id } params, RequestOptionsoptions?): Ramp { id, created_on, modified_on, 8 more }
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
Create CF1 Site Ramps
client.magicTransit.cf1Sites.ramps.create(stringcf1SiteId, RampCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<Ramp { id, created_on, modified_on, 8 more } >
POST/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Delete CF1 Site Ramp
client.magicTransit.cf1Sites.ramps.delete(stringcf1SiteId, stringrampId, RampDeleteParams { account_id } params, RequestOptionsoptions?): Ramp { id, created_on, modified_on, 8 more }
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
ModelsExpand Collapse
Ramp { id, created_on, modified_on, 8 more }
id: string

Identifier

maxLength32
created_on: string
formatdate-time
modified_on: string
formatdate-time
name: string

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?: string

A human-provided description of the ramp.

gre?: GRE { managed_by }
managed_by?: string

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

gre_interconnect?: GREInterconnect { managed_by }
managed_by?: string

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

ipsec?: IPSEC { managed_by }
managed_by?: string

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

mconn?: Mconn { managed_by }
managed_by?: string

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

mpls_interconnect?: MplsInterconnect { managed_by }
managed_by?: string

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

RampType = "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"