cloudflare/resources/zero-trust/tunnels/configurations.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as ConfigurationsAPI from 'cloudflare/resources/zero-trust/tunnels/configurations';
export declare class Configurations extends APIResource {
    /**
     * Adds or updates the configuration for a remotely-managed tunnel.
     */
    update(tunnelId: string, params: ConfigurationUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ConfigurationUpdateResponse>;
    /**
     * Gets the configuration for a remotely-managed tunnel
     */
    get(tunnelId: string, params: ConfigurationGetParams, options?: Core.RequestOptions): Core.APIPromise<ConfigurationGetResponse>;
}
export type ConfigurationUpdateResponse = unknown | Array<unknown> | string;
export type ConfigurationGetResponse = unknown | Array<unknown> | string;
export interface ConfigurationUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The tunnel configuration and ingress rules.
     */
    config?: ConfigurationUpdateParams.Config;
}
export declare namespace ConfigurationUpdateParams {
    /**
     * The tunnel configuration and ingress rules.
     */
    interface Config {
        /**
         * List of public hostname definitions
         */
        ingress?: Array<Config.Ingress>;
        /**
         * Configuration parameters of connection between cloudflared and origin server.
         */
        originRequest?: Config.OriginRequest;
        /**
         * Enable private network access from WARP users to private network routes
         */
        'warp-routing'?: Config.WARPRouting;
    }
    namespace Config {
        /**
         * Public hostname
         */
        interface Ingress {
            /**
             * Public hostname for this service.
             */
            hostname: string;
            /**
             * Protocol and address of destination server. Supported protocols: http://,
             * https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively
             * can return a HTTP status code http_status:[code] e.g. 'http_status:404'.
             */
            service: string;
            /**
             * Configuration parameters of connection between cloudflared and origin server.
             */
            originRequest?: Ingress.OriginRequest;
            /**
             * Requests with this path route to this public hostname.
             */
            path?: string;
        }
        namespace Ingress {
            /**
             * Configuration parameters of connection between cloudflared and origin server.
             */
            interface OriginRequest {
                /**
                 * For all L7 requests to this hostname, cloudflared will validate each request's
                 * Cf-Access-Jwt-Assertion request header.
                 */
                access?: OriginRequest.Access;
                /**
                 * Path to the certificate authority (CA) for the certificate of your origin. This
                 * option should be used only if your certificate is not signed by Cloudflare.
                 */
                caPool?: string;
                /**
                 * Timeout for establishing a new TCP connection to your origin server. This
                 * excludes the time taken to establish TLS, which is controlled by tlsTimeout.
                 */
                connectTimeout?: number;
                /**
                 * Disables chunked transfer encoding. Useful if you are running a WSGI server.
                 */
                disableChunkedEncoding?: boolean;
                /**
                 * Attempt to connect to origin using HTTP2. Origin must be configured as https.
                 */
                http2Origin?: boolean;
                /**
                 * Sets the HTTP Host header on requests sent to the local service.
                 */
                httpHostHeader?: string;
                /**
                 * Maximum number of idle keepalive connections between Tunnel and your origin.
                 * This does not restrict the total number of concurrent connections.
                 */
                keepAliveConnections?: number;
                /**
                 * Timeout after which an idle keepalive connection can be discarded.
                 */
                keepAliveTimeout?: number;
                /**
                 * Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local
                 * network has misconfigured one of the protocols.
                 */
                noHappyEyeballs?: boolean;
                /**
                 * Disables TLS verification of the certificate presented by your origin. Will
                 * allow any certificate from the origin to be accepted.
                 */
                noTLSVerify?: boolean;
                /**
                 * Hostname that cloudflared should expect from your origin server certificate.
                 */
                originServerName?: string;
                /**
                 * cloudflared starts a proxy server to translate HTTP traffic into TCP when
                 * proxying, for example, SSH or RDP. This configures what type of proxy will be
                 * started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5
                 * proxy.
                 */
                proxyType?: string;
                /**
                 * The timeout after which a TCP keepalive packet is sent on a connection between
                 * Tunnel and the origin server.
                 */
                tcpKeepAlive?: number;
                /**
                 * Timeout for completing a TLS handshake to your origin server, if you have chosen
                 * to connect Tunnel to an HTTPS server.
                 */
                tlsTimeout?: number;
            }
            namespace OriginRequest {
                /**
                 * For all L7 requests to this hostname, cloudflared will validate each request's
                 * Cf-Access-Jwt-Assertion request header.
                 */
                interface Access {
                    /**
                     * Access applications that are allowed to reach this hostname for this Tunnel.
                     * Audience tags can be identified in the dashboard or via the List Access policies
                     * API.
                     */
                    audTag: Array<string>;
                    teamName: string;
                    /**
                     * Deny traffic that has not fulfilled Access authorization.
                     */
                    required?: boolean;
                }
            }
        }
        /**
         * Configuration parameters of connection between cloudflared and origin server.
         */
        interface OriginRequest {
            /**
             * For all L7 requests to this hostname, cloudflared will validate each request's
             * Cf-Access-Jwt-Assertion request header.
             */
            access?: OriginRequest.Access;
            /**
             * Path to the certificate authority (CA) for the certificate of your origin. This
             * option should be used only if your certificate is not signed by Cloudflare.
             */
            caPool?: string;
            /**
             * Timeout for establishing a new TCP connection to your origin server. This
             * excludes the time taken to establish TLS, which is controlled by tlsTimeout.
             */
            connectTimeout?: number;
            /**
             * Disables chunked transfer encoding. Useful if you are running a WSGI server.
             */
            disableChunkedEncoding?: boolean;
            /**
             * Attempt to connect to origin using HTTP2. Origin must be configured as https.
             */
            http2Origin?: boolean;
            /**
             * Sets the HTTP Host header on requests sent to the local service.
             */
            httpHostHeader?: string;
            /**
             * Maximum number of idle keepalive connections between Tunnel and your origin.
             * This does not restrict the total number of concurrent connections.
             */
            keepAliveConnections?: number;
            /**
             * Timeout after which an idle keepalive connection can be discarded.
             */
            keepAliveTimeout?: number;
            /**
             * Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local
             * network has misconfigured one of the protocols.
             */
            noHappyEyeballs?: boolean;
            /**
             * Disables TLS verification of the certificate presented by your origin. Will
             * allow any certificate from the origin to be accepted.
             */
            noTLSVerify?: boolean;
            /**
             * Hostname that cloudflared should expect from your origin server certificate.
             */
            originServerName?: string;
            /**
             * cloudflared starts a proxy server to translate HTTP traffic into TCP when
             * proxying, for example, SSH or RDP. This configures what type of proxy will be
             * started. Valid options are: "" for the regular proxy and "socks" for a SOCKS5
             * proxy.
             */
            proxyType?: string;
            /**
             * The timeout after which a TCP keepalive packet is sent on a connection between
             * Tunnel and the origin server.
             */
            tcpKeepAlive?: number;
            /**
             * Timeout for completing a TLS handshake to your origin server, if you have chosen
             * to connect Tunnel to an HTTPS server.
             */
            tlsTimeout?: number;
        }
        namespace OriginRequest {
            /**
             * For all L7 requests to this hostname, cloudflared will validate each request's
             * Cf-Access-Jwt-Assertion request header.
             */
            interface Access {
                /**
                 * Access applications that are allowed to reach this hostname for this Tunnel.
                 * Audience tags can be identified in the dashboard or via the List Access policies
                 * API.
                 */
                audTag: Array<string>;
                teamName: string;
                /**
                 * Deny traffic that has not fulfilled Access authorization.
                 */
                required?: boolean;
            }
        }
        /**
         * Enable private network access from WARP users to private network routes
         */
        interface WARPRouting {
            enabled?: boolean;
        }
    }
}
export interface ConfigurationGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace Configurations {
    export import ConfigurationUpdateResponse = ConfigurationsAPI.ConfigurationUpdateResponse;
    export import ConfigurationGetResponse = ConfigurationsAPI.ConfigurationGetResponse;
    export import ConfigurationUpdateParams = ConfigurationsAPI.ConfigurationUpdateParams;
    export import ConfigurationGetParams = ConfigurationsAPI.ConfigurationGetParams;
}
//# sourceMappingURL=configurations.d.ts.map