Skip to content
Cloudflare API
Start here
API Reference
Magic Transit

Cf1 Sites

List CF1 Sites
client.MagicTransit.Cf1Sites.List(ctx, query) (*SinglePage[Cf1Site], error)
GET/accounts/{account_id}/magic/cf1_sites
Get CF1 Site
client.MagicTransit.Cf1Sites.Get(ctx, cf1SiteID, query) (*Cf1Site, error)
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Create CF1 Sites
client.MagicTransit.Cf1Sites.New(ctx, params) (*SinglePage[Cf1Site], error)
POST/accounts/{account_id}/magic/cf1_sites
Update CF1 Site
client.MagicTransit.Cf1Sites.Update(ctx, cf1SiteID, params) (*Cf1Site, error)
PATCH/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Delete CF1 Site
client.MagicTransit.Cf1Sites.Delete(ctx, cf1SiteID, body) (*Cf1Site, error)
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
ModelsExpand Collapse
type Cf1Site struct{…}
Name string

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

ID stringOptional

Identifier

maxLength32
CreatedOn TimeOptional
formatdate-time
Description stringOptional

A human-provided description of the CF1 Site.

Location Cf1SiteLocationOptional
ModifiedOn TimeOptional
formatdate-time
type Cf1SiteLocation struct{…}
Lat float64Optional

Latitude of the CF1 Site.

formatfloat
Long float64Optional

Longitude of the CF1 Site.

formatfloat
Name stringOptional

Name of nearest town, city, or village.

Cf1 SitesRamps

List CF1 Site Ramps
client.MagicTransit.Cf1Sites.Ramps.List(ctx, cf1SiteID, query) (*SinglePage[Ramp], error)
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Get CF1 Site Ramp
client.MagicTransit.Cf1Sites.Ramps.Get(ctx, cf1SiteID, rampID, query) (*Ramp, error)
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
Create CF1 Site Ramps
client.MagicTransit.Cf1Sites.Ramps.New(ctx, cf1SiteID, params) (*SinglePage[Ramp], error)
POST/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Delete CF1 Site Ramp
client.MagicTransit.Cf1Sites.Ramps.Delete(ctx, cf1SiteID, rampID, body) (*Ramp, error)
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
ModelsExpand Collapse
type Ramp struct{…}
ID string

Identifier

maxLength32
CreatedOn Time
formatdate-time
ModifiedOn Time
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 stringOptional

A human-provided description of the ramp.

GRE RampGREOptional
ManagedBy stringOptional

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

GREInterconnect RampGREInterconnectOptional
ManagedBy stringOptional

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

IPSEC RampIPSECOptional
ManagedBy stringOptional

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

Mconn RampMconnOptional
ManagedBy stringOptional

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

MplsInterconnect RampMplsInterconnectOptional
ManagedBy stringOptional

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

type RampType string

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

One of the following:
const RampTypeGRE RampType = "gre"
const RampTypeGREInterconnect RampType = "gre_interconnect"
const RampTypeMplsInterconnect RampType = "mpls_interconnect"
const RampTypeMconn RampType = "mconn"
const RampTypeIPSEC RampType = "ipsec"