API Reference

Magic Transit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cf Interconnects

List interconnects

client.magicTransit.cfInterconnects.list(CfInterconnectListParams { account_id, xMagicNewHcTarget } params, RequestOptionsoptions?): CfInterconnectListResponse { interconnects }

GET/accounts/{account_id}/magic/cf_interconnects

List interconnect Details

client.magicTransit.cfInterconnects.get(stringcfInterconnectId, CfInterconnectGetParams { account_id, xMagicNewHcTarget } params, RequestOptionsoptions?): CfInterconnectGetResponse { interconnect }

GET/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}

Update interconnect

client.magicTransit.cfInterconnects.update(stringcfInterconnectId, CfInterconnectUpdateParams { account_id, automatic_return_routing, description, 7 more } params, RequestOptionsoptions?): CfInterconnectUpdateResponse { modified, modified_interconnect }

PUT/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}

Update multiple interconnects

client.magicTransit.cfInterconnects.bulkUpdate(CfInterconnectBulkUpdateParams { account_id, body, xMagicNewHcTarget } params, RequestOptionsoptions?): CfInterconnectBulkUpdateResponse { modified, modified_interconnects }

PUT/accounts/{account_id}/magic/cf_interconnects

ModelsExpand Collapse

CfInterconnectListResponse { interconnects }

interconnects?: Array<Interconnect>

id?: string

Identifier

maxLength32

automatic_return_routing?: boolean

True if automatic stateful return routing should be enabled for a tunnel, false otherwise.

colo_name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

created_on?: string

The date and time the tunnel was created.

formatdate-time

description?: string

An optional description of the interconnect.

gre?: GRE { cloudflare_endpoint }

The configuration specific to GRE interconnects.

cloudflare_endpoint?: string

The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.

health_check?: HealthCheck { enabled, rate, target, type }

interface_address?: string

A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.

interface_address6?: string

A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127

modified_on?: string

The date and time the tunnel was last modified.

formatdate-time

mtu?: number

The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.

name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

virtual_port_reservation_id?: string

An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource.

maxLength32

CfInterconnectGetResponse { interconnect }

interconnect?: Interconnect { id, automatic_return_routing, colo_name, 10 more }

id?: string

Identifier

maxLength32

automatic_return_routing?: boolean

True if automatic stateful return routing should be enabled for a tunnel, false otherwise.

colo_name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

created_on?: string

The date and time the tunnel was created.

formatdate-time

description?: string

An optional description of the interconnect.

gre?: GRE { cloudflare_endpoint }

The configuration specific to GRE interconnects.

cloudflare_endpoint?: string

The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.

health_check?: HealthCheck { enabled, rate, target, type }

interface_address?: string

A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.

interface_address6?: string

A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127

modified_on?: string

The date and time the tunnel was last modified.

formatdate-time

mtu?: number

The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.

name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

virtual_port_reservation_id?: string

An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource.

maxLength32

CfInterconnectUpdateResponse { modified, modified_interconnect }

modified?: boolean

modified_interconnect?: ModifiedInterconnect { id, automatic_return_routing, colo_name, 10 more }

id?: string

Identifier

maxLength32

automatic_return_routing?: boolean

True if automatic stateful return routing should be enabled for a tunnel, false otherwise.

colo_name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

created_on?: string

The date and time the tunnel was created.

formatdate-time

description?: string

An optional description of the interconnect.

gre?: GRE { cloudflare_endpoint }

The configuration specific to GRE interconnects.

cloudflare_endpoint?: string

The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.

health_check?: HealthCheck { enabled, rate, target, type }

interface_address?: string

A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.

interface_address6?: string

A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127

modified_on?: string

The date and time the tunnel was last modified.

formatdate-time

mtu?: number

The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.

name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

virtual_port_reservation_id?: string

An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource.

maxLength32

CfInterconnectBulkUpdateResponse { modified, modified_interconnects }

modified?: boolean

modified_interconnects?: Array<ModifiedInterconnect>

id?: string

Identifier

maxLength32

automatic_return_routing?: boolean

True if automatic stateful return routing should be enabled for a tunnel, false otherwise.

colo_name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

created_on?: string

The date and time the tunnel was created.

formatdate-time

description?: string

An optional description of the interconnect.

gre?: GRE { cloudflare_endpoint }

The configuration specific to GRE interconnects.

cloudflare_endpoint?: string

The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.

health_check?: HealthCheck { enabled, rate, target, type }

interface_address?: string

A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.

interface_address6?: string

A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127

modified_on?: string

The date and time the tunnel was last modified.

formatdate-time

mtu?: number

The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.

name?: string

The name of the interconnect. The name cannot share a name with other tunnels.

virtual_port_reservation_id?: string

An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource.

maxLength32