Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.
/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}
put
Magic GRE tunnels
magic-gre-tunnels-update-gre-tunnel
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "tunnel_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"cloudflare_gre_endpoint": {
"description": "The IP address assigned to the Cloudflare side of the GRE tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"customer_gre_endpoint": {
"description": "The IP address assigned to the customer side of the GRE tunnel.",
"example": "203.0.113.1",
"type": "string"
},
"description": {
"description": "An optional description of the GRE tunnel.",
"example": "Tunnel for ISP X",
"type": "string"
},
"health_check": {
"properties": {
"direction": {
"default": "unidirectional",
"description": "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.",
"enum": [
"unidirectional",
"bidirectional"
],
"example": "bidirectional",
"type": "string"
},
"enabled": {
"default": true,
"description": "Determines whether to run healthchecks for a tunnel.",
"example": true,
"type": "boolean"
},
"rate": {
"default": "mid",
"description": "How frequent the health check is run. The default value is `mid`.",
"enum": [
"low",
"mid",
"high"
],
"example": "low",
"type": "string"
},
"target": {
"description": "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`.",
"example": "203.0.113.1",
"type": "string"
},
"type": {
"default": "reply",
"description": "The type of healthcheck to run, reply or request. The default value is `reply`.",
"enum": [
"reply",
"request"
],
"example": "request",
"type": "string"
}
},
"type": "object"
},
"interface_address": {
"description": "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",
"type": "string"
},
"mtu": {
"default": 1476,
"description": "Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.",
"type": "integer"
},
"name": {
"description": "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",
"type": "string"
},
"ttl": {
"default": 64,
"description": "Time To Live (TTL) in number of hops of the GRE tunnel.",
"type": "integer"
}
},
"required": [
"name",
"customer_gre_endpoint",
"cloudflare_gre_endpoint",
"interface_address"
],
"type": "object"
}
]
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"modified": {
"example": true,
"type": "boolean"
},
"modified_gre_tunnel": {
"type": "object"
}
}
}
}
}
]
}
}
},
"description": "Update GRE Tunnel response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"modified": {
"example": true,
"type": "boolean"
},
"modified_gre_tunnel": {
"type": "object"
}
}
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Update GRE Tunnel response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]