Create a GRE tunnel

POST/accounts/{account_id}/magic/gre_tunnels

Creates a new GRE tunnel. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Magic WAN WriteMagic Transit Write

Path ParametersExpand Collapse

account_id: string

Identifier

maxLength32

Header ParametersExpand Collapse

"x-magic-new-hc-target": optional boolean

Body ParametersJSONExpand Collapse

cloudflare_gre_endpoint: string

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

customer_gre_endpoint: string

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

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.

name: string

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.

automatic_return_routing: optional boolean

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

bgp: optional object { customer_asn, extra_prefixes, md5_key }

customer_asn: number

ASN used on the customer end of the BGP session

formatint32

minimum0

extra_prefixes: optional array of string

Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table.

md5_key: optional string

MD5 key to use for session authentication.

Note that this is not a security measure. MD5 is not a valid security mechanism, and the key is not treated as a secret value. This is only supported for preventing misconfiguration, not for defending against malicious attacks.

The MD5 key, if set, must be of non-zero length and consist only of the following types of character:

ASCII alphanumerics: [a-zA-Z0-9]
Special characters in the set '!@#$%^&*()+[]{}<>/.,;:_-~= |`

In other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A), quotation mark ("), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed (0x0C), and the question mark (?). Requests specifying an MD5 key with one or more of these disallowed characters will be rejected.

description: optional string

An optional description of the GRE tunnel.

health_check: optional object { direction, enabled, rate, 2 more }

direction: optional "unidirectional" or "bidirectional"

The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.

One of the following:

"unidirectional"

"bidirectional"

enabled: optional boolean

Determines whether to run healthchecks for a tunnel.

rate: optional HealthCheckRate

How frequent the health check is run. The default value is mid.

One of the following:

"low"

"mid"

"high"

target: optional object { effective, saved } or string

The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to customer_gre_endpoint address. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.

One of the following:

MagicHealthCheckTarget = object { effective, saved }

effective: optional string

The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests.

saved: optional string

The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used.

string

type: optional HealthCheckType

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

One of the following:

"reply"

"request"

interface_address6: optional 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

mtu: optional number

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

ttl: optional number

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

ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: object { id, cloudflare_gre_endpoint, customer_gre_endpoint, 12 more }

id: string

Identifier

maxLength32

cloudflare_gre_endpoint: string

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

customer_gre_endpoint: string

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

interface_address: string

name: string

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.

automatic_return_routing: optional boolean

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

bgp: optional object { customer_asn, extra_prefixes, md5_key }

customer_asn: number

ASN used on the customer end of the BGP session

formatint32

minimum0

extra_prefixes: optional array of string

Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table.

md5_key: optional string

MD5 key to use for session authentication.

The MD5 key, if set, must be of non-zero length and consist only of the following types of character:

ASCII alphanumerics: [a-zA-Z0-9]
Special characters in the set '!@#$%^&*()+[]{}<>/.,;:_-~= |`

bgp_status: optional object { state, tcp_established, updated_at, 5 more }

state: "BGP_DOWN" or "BGP_UP" or "BGP_ESTABLISHING"

One of the following:

"BGP_DOWN"

"BGP_UP"

"BGP_ESTABLISHING"

tcp_established: boolean

updated_at: string

formatdate-time

bgp_state: optional string

cf_speaker_ip: optional string

formatipv4

cf_speaker_port: optional number

maximum65535

minimum1

customer_speaker_ip: optional string

formatipv4

customer_speaker_port: optional number

maximum65535

minimum1

created_on: optional string

The date and time the tunnel was created.

formatdate-time

description: optional string

An optional description of the GRE tunnel.

health_check: optional object { direction, enabled, rate, 2 more }

direction: optional "unidirectional" or "bidirectional"

One of the following:

"unidirectional"

"bidirectional"

enabled: optional boolean

Determines whether to run healthchecks for a tunnel.

rate: optional HealthCheckRate

How frequent the health check is run. The default value is mid.

One of the following:

"low"

"mid"

"high"

target: optional object { effective, saved } or string

One of the following:

MagicHealthCheckTarget = object { effective, saved }

effective: optional string

The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests.

saved: optional string

The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used.

string

type: optional HealthCheckType

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

One of the following:

"reply"

"request"

interface_address6: optional string

modified_on: optional string

The date and time the tunnel was last modified.

formatdate-time

mtu: optional number

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

ttl: optional number

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

success: true

Whether the API call was successful

Create a GRE tunnel

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/magic/gre_tunnels \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "cloudflare_gre_endpoint": "203.0.113.1",
          "customer_gre_endpoint": "203.0.113.1",
          "interface_address": "192.0.2.0/31",
          "name": "GRE_1",
          "automatic_return_routing": true,
          "description": "Tunnel for ISP X",
          "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127"
        }'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "customer_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31",
    "name": "GRE_1",
    "automatic_return_routing": true,
    "bgp": {
      "customer_asn": 0,
      "extra_prefixes": [
        "string"
      ],
      "md5_key": "md5_key"
    },
    "bgp_status": {
      "state": "BGP_DOWN",
      "tcp_established": true,
      "updated_at": "2019-12-27T18:11:19.117Z",
      "bgp_state": "bgp_state",
      "cf_speaker_ip": "192.168.1.1",
      "cf_speaker_port": 1,
      "customer_speaker_ip": "192.168.1.1",
      "customer_speaker_port": 1
    },
    "created_on": "2017-06-14T00:00:00Z",
    "description": "Tunnel for ISP X",
    "health_check": {
      "direction": "bidirectional",
      "enabled": true,
      "rate": "low",
      "target": {
        "effective": "203.0.113.1",
        "saved": "203.0.113.1"
      },
      "type": "request"
    },
    "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127",
    "modified_on": "2017-06-14T05:20:00Z",
    "mtu": 0,
    "ttl": 0
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "c4a7362d577a6c3019a474fd6f485821",
    "cloudflare_gre_endpoint": "203.0.113.1",
    "customer_gre_endpoint": "203.0.113.1",
    "interface_address": "192.0.2.0/31",
    "name": "GRE_1",
    "automatic_return_routing": true,
    "bgp": {
      "customer_asn": 0,
      "extra_prefixes": [
        "string"
      ],
      "md5_key": "md5_key"
    },
    "bgp_status": {
      "state": "BGP_DOWN",
      "tcp_established": true,
      "updated_at": "2019-12-27T18:11:19.117Z",
      "bgp_state": "bgp_state",
      "cf_speaker_ip": "192.168.1.1",
      "cf_speaker_port": 1,
      "customer_speaker_ip": "192.168.1.1",
      "customer_speaker_port": 1
    },
    "created_on": "2017-06-14T00:00:00Z",
    "description": "Tunnel for ISP X",
    "health_check": {
      "direction": "bidirectional",
      "enabled": true,
      "rate": "low",
      "target": {
        "effective": "203.0.113.1",
        "saved": "203.0.113.1"
      },
      "type": "request"
    },
    "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127",
    "modified_on": "2017-06-14T05:20:00Z",
    "mtu": 0,
    "ttl": 0
  },
  "success": true
}