Update interconnect

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}

Last modified:2022-12-16 13:48:33

Updates a specific interconnect associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Request

Path Params

tunnel_identifier

string

required

account_identifier

string

required

Body Params application/json

description

string

optional

An optional description of the interconnect.

Example:

Tunnel for Interconnect to ORD

gre

object (gre)

optional

The configuration specific to GRE interconnects.

cloudflare_endpoint

string

optional

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

Example:

203.0.113.1

health_check

object (schemas-health_check)

optional

enabled

boolean

optional

Determines whether to run healthchecks for a tunnel.

Default:

true

Example:

true

target

string

optional

The address used to run healthchecks for a tunnel.

Example:

203.0.113.1

type

enum<string>

optional

The type of healthcheck to run, reply or request. The default value is reply.

Allowed values:

replyrequest

Default:

Example:

request

interface_address

string

optional

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.

Example:

192.0.2.0/31

mtu

integer

optional

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

Default:

1476

Example

{
    "description": "Tunnel for Interconnect to ORD",
    "gre": {
        "cloudflare_endpoint": "203.0.113.1"
    },
    "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
    },
    "interface_address": "192.0.2.0/31",
    "mtu": 1476
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//magic/cf_interconnects/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Tunnel for Interconnect to ORD",
    "gre": {
        "cloudflare_endpoint": "203.0.113.1"
    },
    "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
    },
    "interface_address": "192.0.2.0/31",
    "mtu": 1476
}'

Responses

🟢200Update interconnect response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "modified": true,
        "modified_interconnect": {}
    },
    "success": true
}

🟢200Update interconnect response failure

Modified at 2022-12-16 13:48:33

List interconnect Details

Delete account configuration