Skip to content
Start here

Cf1 Sites

List CF1 Sites
GET/accounts/{account_id}/magic/cf1_sites
Get CF1 Site
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Create CF1 Sites
POST/accounts/{account_id}/magic/cf1_sites
Update CF1 Site
PATCH/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
Delete CF1 Site
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}
ModelsExpand Collapse
Cf1Site object { name, id, created_on, 3 more }
name: string

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

id: optional string

Identifier

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

A human-provided description of the CF1 Site.

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

Latitude of the CF1 Site.

formatfloat
long: optional number

Longitude of the CF1 Site.

formatfloat
name: optional string

Name of nearest town, city, or village.

Cf1 SitesRamps

List CF1 Site Ramps
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Get CF1 Site Ramp
GET/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
Create CF1 Site Ramps
POST/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps
Delete CF1 Site Ramp
DELETE/accounts/{account_id}/magic/cf1_sites/{cf1_site_id}/ramps/{ramp_id}
ModelsExpand Collapse
Ramp object { 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: optional string

A human-provided description of the ramp.

gre: optional object { managed_by }
managed_by: optional string

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

gre_interconnect: optional object { managed_by }
managed_by: optional string

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

ipsec: optional object { managed_by }
managed_by: optional string

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

mconn: optional object { managed_by }
managed_by: optional string

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

mpls_interconnect: optional object { managed_by }
managed_by: optional string

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

RampType = "gre" or "gre_interconnect" or "mpls_interconnect" or 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"