cloudflare
Version:
The official TypeScript library for the Cloudflare API
1,186 lines • 58.1 kB
TypeScript
import { APIResource } from "../../resource.js";
import * as Core from "../../core.js";
import * as MagicTransitAPI from "./magic-transit.js";
export declare class GRETunnels extends APIResource {
/**
* Creates a new GRE tunnel. Use `?validate_only=true` as an optional query
* parameter to only run validation without persisting changes.
*
* @example
* ```ts
* const greTunnel =
* await client.magicTransit.greTunnels.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* cloudflare_gre_endpoint: '203.0.113.1',
* customer_gre_endpoint: '203.0.113.1',
* interface_address: '192.0.2.0/31',
* name: 'GRE_1',
* });
* ```
*/
create(params: GRETunnelCreateParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelCreateResponse>;
/**
* Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query
* parameter to only run validation without persisting changes.
*
* @example
* ```ts
* const greTunnel =
* await client.magicTransit.greTunnels.update(
* '023e105f4ecef8ad9ca31a8372d0c353',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* cloudflare_gre_endpoint: '203.0.113.1',
* customer_gre_endpoint: '203.0.113.1',
* interface_address: '192.0.2.0/31',
* name: 'GRE_1',
* },
* );
* ```
*/
update(greTunnelId: string, params: GRETunnelUpdateParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelUpdateResponse>;
/**
* Lists GRE tunnels associated with an account.
*
* @example
* ```ts
* const greTunnels =
* await client.magicTransit.greTunnels.list({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
list(params: GRETunnelListParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelListResponse>;
/**
* Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as
* an optional query parameter to only run validation without persisting changes.
*
* @example
* ```ts
* const greTunnel =
* await client.magicTransit.greTunnels.delete(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(greTunnelId: string, params: GRETunnelDeleteParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelDeleteResponse>;
/**
* Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query
* parameter to only run validation without persisting changes.
*
* @example
* ```ts
* const response =
* await client.magicTransit.greTunnels.bulkUpdate({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* body: {},
* });
* ```
*/
bulkUpdate(params: GRETunnelBulkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelBulkUpdateResponse>;
/**
* Lists informtion for a specific GRE tunnel.
*
* @example
* ```ts
* const greTunnel = await client.magicTransit.greTunnels.get(
* '023e105f4ecef8ad9ca31a8372d0c353',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(greTunnelId: string, params: GRETunnelGetParams, options?: Core.RequestOptions): Core.APIPromise<GRETunnelGetResponse>;
}
export interface GRETunnelCreateResponse {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: GRETunnelCreateResponse.BGP;
bgp_status?: GRETunnelCreateResponse.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: GRETunnelCreateResponse.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
export declare namespace GRETunnelCreateResponse {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
export interface GRETunnelUpdateResponse {
modified?: boolean;
modified_gre_tunnel?: GRETunnelUpdateResponse.ModifiedGRETunnel;
}
export declare namespace GRETunnelUpdateResponse {
interface ModifiedGRETunnel {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: ModifiedGRETunnel.BGP;
bgp_status?: ModifiedGRETunnel.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: ModifiedGRETunnel.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
namespace ModifiedGRETunnel {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
}
export interface GRETunnelListResponse {
gre_tunnels?: Array<GRETunnelListResponse.GRETunnel>;
}
export declare namespace GRETunnelListResponse {
interface GRETunnel {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: GRETunnel.BGP;
bgp_status?: GRETunnel.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: GRETunnel.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
namespace GRETunnel {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
}
export interface GRETunnelDeleteResponse {
deleted?: boolean;
deleted_gre_tunnel?: GRETunnelDeleteResponse.DeletedGRETunnel;
}
export declare namespace GRETunnelDeleteResponse {
interface DeletedGRETunnel {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: DeletedGRETunnel.BGP;
bgp_status?: DeletedGRETunnel.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: DeletedGRETunnel.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
namespace DeletedGRETunnel {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
}
export interface GRETunnelBulkUpdateResponse {
modified?: boolean;
modified_gre_tunnels?: Array<GRETunnelBulkUpdateResponse.ModifiedGRETunnel>;
}
export declare namespace GRETunnelBulkUpdateResponse {
interface ModifiedGRETunnel {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: ModifiedGRETunnel.BGP;
bgp_status?: ModifiedGRETunnel.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: ModifiedGRETunnel.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
namespace ModifiedGRETunnel {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
}
export interface GRETunnelGetResponse {
gre_tunnel?: GRETunnelGetResponse.GRETunnel;
}
export declare namespace GRETunnelGetResponse {
interface GRETunnel {
/**
* Identifier
*/
id: string;
/**
* The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: 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.
*/
interface_address: 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.
*/
name: string;
/**
* True if automatic stateful return routing should be enabled for a tunnel, false
* otherwise.
*/
automatic_return_routing?: boolean;
bgp?: GRETunnel.BGP;
bgp_status?: GRETunnel.BGPStatus;
/**
* The date and time the tunnel was created.
*/
created_on?: string;
/**
* An optional description of the GRE tunnel.
*/
description?: string;
health_check?: GRETunnel.HealthCheck;
/**
* 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
*/
interface_address6?: string;
/**
* The date and time the tunnel was last modified.
*/
modified_on?: string;
/**
* Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value
* is 576.
*/
mtu?: number;
/**
* Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
}
namespace GRETunnel {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface BGPStatus {
state: 'BGP_DOWN' | 'BGP_UP' | 'BGP_ESTABLISHING';
tcp_established: boolean;
updated_at: string;
bgp_state?: string;
cf_speaker_ip?: string;
cf_speaker_port?: number;
customer_speaker_ip?: string;
customer_speaker_port?: number;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRate;
/**
* 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.
*/
target?: HealthCheck.MagicHealthCheckTarget | string;
/**
* The type of healthcheck to run, reply or request. The default value is `reply`.
*/
type?: MagicTransitAPI.HealthCheckType;
}
namespace HealthCheck {
/**
* 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.
*/
interface MagicHealthCheckTarget {
/**
* 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.
*/
effective?: string;
/**
* The saved health check target. Setting the value to the empty string indicates
* that the calculated default value will be used.
*/
saved?: string;
}
}
}
}
export interface GRETunnelCreateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param: The IP address assigned to the Cloudflare side of the GRE tunnel.
*/
cloudflare_gre_endpoint: string;
/**
* Body param: The IP address assigned to the customer side of the GRE tunnel.
*/
customer_gre_endpoint: string;
/**
* Body param: 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.
*/
interface_address: string;
/**
* Body param: 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.
*/
name: string;
/**
* Body param: True if automatic stateful return routing should be enabled for a
* tunnel, false otherwise.
*/
automatic_return_routing?: boolean;
/**
* Body param:
*/
bgp?: GRETunnelCreateParams.BGP;
/**
* Body param: An optional description of the GRE tunnel.
*/
description?: string;
/**
* Body param:
*/
health_check?: GRETunnelCreateParams.HealthCheck;
/**
* Body param: 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
*/
interface_address6?: string;
/**
* Body param: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The
* minimum value is 576.
*/
mtu?: number;
/**
* Body param: Time To Live (TTL) in number of hops of the GRE tunnel.
*/
ttl?: number;
/**
* Header param: If true, the health check target in the request and response
* bodies will be presented using the new object format. Defaults to false.
*/
'x-magic-new-hc-target'?: boolean;
}
export declare namespace GRETunnelCreateParams {
interface BGP {
/**
* ASN used on the customer end of the BGP session
*/
customer_asn: number;
/**
* Prefixes in this list will be advertised to the customer device, in addition to
* the routes in the Magic routing table.
*/
extra_prefixes?: Array<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.
*/
md5_key?: string;
}
interface HealthCheck {
/**
* 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.
*/
direction?: 'unidirectional' | 'bidirectional';
/**
* Determines whether to run healthchecks for a tunnel.
*/
enabled?: boolean;
/**
* How frequent the health check is run. The default value is `mid`.
*/
rate?: MagicTransitAPI.HealthCheckRateParam;
/**
* The destination address in a request type health check. After the healthcheck is
* decapsulated at the customer end of the tunnel, the