Update GRE Tunnel - Cloudflare

Updates a specific GRE tunnel. 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

cloudflare_gre_endpoint

string

cloudflare_gre_endpoint

required

The IP address assigned to the Cloudflare side of the GRE tunnel.

Example:

203.0.113.1

customer_gre_endpoint

string

customer_gre_endpoint

required

The IP address assigned to the customer side of the GRE tunnel.

Example:

203.0.113.1

description

string

gre-tunnel_components-schemas-description

optional

An optional description of the GRE tunnel.

Example:

Tunnel for ISP X

health_check

object

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. This field defaults to customer_gre_endpoint address.

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

interface_address

required

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

mtu

optional

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

Default:

1476

name

string

gre-tunnel_components-schemas-name

required

The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.

Example:

GRE_1

ttl

integer

components-schemas-ttl

optional

Time To Live (TTL) in number of hops of the GRE tunnel.

Default:

Example

{
    "cloudflare_gre_endpoint": "203.0.113.1",
    "customer_gre_endpoint": "203.0.113.1",
    "description": "Tunnel for ISP X",
    "health_check": {
        "enabled": true,
        "target": "203.0.113.1",
        "type": "request"
    },
    "interface_address": "192.0.2.0/31",
    "mtu": 1476,
    "name": "GRE_1",
    "ttl": 64
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Update GRE Tunnel 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_gre_tunnel": {}
    },
    "success": true
}

🟢200Update GRE Tunnel response failure