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.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-magic-new-hc-target |
Boolean | No |
If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
customer_gre_endpoint |
String | Yes |
The IP address assigned to the customer side of the GRE tunnel. |
ttl |
Integer | No |
Time To Live (TTL) in number of hops of the GRE tunnel. Default value: 64 |
bgp |
Object | No | |
bgp.md5_key |
String | No |
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:
In other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A),
quotation mark ( |
bgp.extra_prefixes[] |
Array | No |
Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. |
bgp.customer_asn |
Integer | Yes |
ASN used on the customer end of the BGP session |
mtu |
Integer | No |
Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Default value: 1476 |
name |
String | Yes |
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. |
description |
String | No |
An optional description of the GRE tunnel. |
interface_address6 |
String | No |
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 |
cloudflare_gre_endpoint |
String | Yes |
The IP address assigned to the Cloudflare side of the GRE tunnel. |
interface_address |
String | Yes |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.