--- title: GRE Tunnels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Magic Transit](https://developers.cloudflare.com/api/python/resources/magic_transit) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # GRE Tunnels ##### [List GRE tunnels](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/list) magic\_transit.gre\_tunnels.list(GRETunnelListParams\*\*kwargs) -> [GRETunnelListResponse]() GET/accounts/{account\_id}/magic/gre\_tunnels ##### [List GRE Tunnel Details](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/get) magic\_transit.gre\_tunnels.get(strgre\_tunnel\_id, GRETunnelGetParams\*\*kwargs) -> [GRETunnelGetResponse]() GET/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Create a GRE tunnel](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/create) magic\_transit.gre\_tunnels.create(GRETunnelCreateParams\*\*kwargs) -> [GRETunnelCreateResponse]() POST/accounts/{account\_id}/magic/gre\_tunnels ##### [Update GRE Tunnel](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/update) magic\_transit.gre\_tunnels.update(strgre\_tunnel\_id, GRETunnelUpdateParams\*\*kwargs) -> [GRETunnelUpdateResponse]() PUT/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Delete GRE Tunnel](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/delete) magic\_transit.gre\_tunnels.delete(strgre\_tunnel\_id, GRETunnelDeleteParams\*\*kwargs) -> [GRETunnelDeleteResponse]() DELETE/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Update multiple GRE tunnels](https://developers.cloudflare.com/api/python/resources/magic_transit/subresources/gre_tunnels/methods/bulk_update) magic\_transit.gre\_tunnels.bulk\_update(GRETunnelBulkUpdateParams\*\*kwargs) -> [GRETunnelBulkUpdateResponse]() PUT/accounts/{account\_id}/magic/gre\_tunnels ##### ModelsExpand Collapse
class GRETunnelListResponse: …
gre\_tunnels: Optional\[List\[GRETunnel]] id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[GRETunnelBGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[GRETunnelBGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[GRETunnelHealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[GRETunnelHealthCheckTarget] 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:
class GRETunnelHealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_list_response%20%3E%20(schema)>)
class GRETunnelGetResponse: …
gre\_tunnel: Optional\[GRETunnel] id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[GRETunnelBGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[GRETunnelBGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[GRETunnelHealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[GRETunnelHealthCheckTarget] 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:
class GRETunnelHealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_get_response%20%3E%20(schema)>)
class GRETunnelCreateResponse: … id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[BGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[BGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[HealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[HealthCheckTarget] 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:
class HealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_create_response%20%3E%20(schema)>)
class GRETunnelUpdateResponse: … modified: Optional\[bool] Link to this property
modified\_gre\_tunnel: Optional\[ModifiedGRETunnel] id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[ModifiedGRETunnelBGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[ModifiedGRETunnelBGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[ModifiedGRETunnelHealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[ModifiedGRETunnelHealthCheckTarget] 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:
class ModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_update_response%20%3E%20(schema)>)
class GRETunnelDeleteResponse: … deleted: Optional\[bool] Link to this property
deleted\_gre\_tunnel: Optional\[DeletedGRETunnel] id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[DeletedGRETunnelBGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[DeletedGRETunnelBGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[DeletedGRETunnelHealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[DeletedGRETunnelHealthCheckTarget] 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:
class DeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_delete_response%20%3E%20(schema)>)
class GRETunnelBulkUpdateResponse: … modified: Optional\[bool] Link to this property
modified\_gre\_tunnels: Optional\[List\[ModifiedGRETunnel]] id: str Identifier maxLength32 Link to this property cloudflare\_gre\_endpoint: str The IP address assigned to the Cloudflare side of the GRE tunnel. Link to this property customer\_gre\_endpoint: str The IP address assigned to the customer side of the GRE tunnel. Link to this property interface\_address: str 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. Link to this property name: str 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. Link to this property automatic\_return\_routing: Optional\[bool] True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected. Link to this property
bgp: Optional\[ModifiedGRETunnelBGP] customer\_asn: int ASN used on the customer end of the BGP session formatint32 minimum0 Link to this property export\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes advertised to the customer. Link to this property extra\_prefixes: Optional\[List\[str]] Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table. Link to this property import\_filter\_id: Optional\[str] ID of the BGP filter profile applied to routes received from the customer. Link to this property md5\_key: Optional\[str] 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. Link to this property
Link to this property
bgp\_status: Optional\[ModifiedGRETunnelBGPStatus]
state: Literal\["BGP\_DOWN", "BGP\_UP", "BGP\_ESTABLISHING"] One of the following: "BGP\_DOWN" Link to this property "BGP\_UP" Link to this property "BGP\_ESTABLISHING" Link to this property
Link to this property tcp\_established: bool Link to this property updated\_at: datetime formatdate-time Link to this property bgp\_state: Optional\[str] Link to this property cf\_speaker\_ip: Optional\[str] formatipv4 Link to this property cf\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property customer\_speaker\_ip: Optional\[str] formatipv4 Link to this property customer\_speaker\_port: Optional\[int] maximum65535 minimum1 Link to this property
Link to this property created\_on: Optional\[datetime] The date and time the tunnel was created. formatdate-time Link to this property description: Optional\[str] An optional description of the GRE tunnel. Link to this property
health\_check: Optional\[ModifiedGRETunnelHealthCheck]
direction: Optional\[Literal\["unidirectional", "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" Link to this property "bidirectional" Link to this property
Link to this property enabled: Optional\[bool] Determines whether to run healthchecks for a tunnel. Link to this property rate: Optional\[HealthCheckRate] How frequent the health check is run. The default value is mid. Link to this property
target: Optional\[ModifiedGRETunnelHealthCheckTarget] 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:
class ModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget: … 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. effective: Optional\[str] 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. Link to this property saved: Optional\[str] The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property
Link to this property str Link to this property
Link to this property type: Optional\[HealthCheckType] The type of healthcheck to run, reply or request. The default value is reply. Link to this property
Link to this property interface\_address6: Optional\[str] 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 Link to this property modified\_on: Optional\[datetime] The date and time the tunnel was last modified. formatdate-time Link to this property mtu: Optional\[int] Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576. Link to this property ttl: Optional\[int] Time To Live (TTL) in number of hops of the GRE tunnel. Link to this property
Link to this property
[Link to this property](<#(resource)%20magic_transit.gre_tunnels%20%3E%20(model)%20gre_tunnel_bulk_update_response%20%3E%20(schema)>)