--- title: Tunnels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Zero Trust](https://developers.cloudflare.com/api/typescript/resources/zero_trust) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Tunnels ##### [List All Tunnels](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/methods/list) client.zeroTrust.tunnels.list(TunnelListParams {account\_id, exclude\_prefix, existed\_at, 10 more } params, RequestOptionsoptions?): V4PagePaginationArray< [TunnelListResponse]()> GET/accounts/{account\_id}/tunnels ##### ModelsExpand Collapse
TunnelListResponse = CloudflareTunnel {id, account\_tag, config\_src, 10 more } | TunnelWARPConnectorTunnel {id, account\_tag, connections, 8 more } A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. One of the following:
CloudflareTunnel {id, account\_tag, config\_src, 10 more } A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
config\_src?: "local"| "cloudflare" Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel on the Zero Trust dashboard. One of the following: "local" Link to this property "cloudflare" Link to this property
Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property Deprecatedremote\_config?: boolean Use the config\_src field instead. If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
Link to this property
TunnelWARPConnectorTunnel {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels%20%3E%20(model)%20tunnel_list_response%20%3E%20(schema)>) #### TunnelsCloudflared ##### [List Cloudflare Tunnels](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/list) client.zeroTrust.tunnels.cloudflared.list(CloudflaredListParams {account\_id, exclude\_prefix, existed\_at, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray< [CloudflareTunnel]() {id, account\_tag, config\_src, 10 more } > GET/accounts/{account\_id}/cfd\_tunnel ##### [Get a Cloudflare Tunnel](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/get) client.zeroTrust.tunnels.cloudflared.get(stringtunnelID, CloudflaredGetParams {account\_id } params, RequestOptionsoptions?): [CloudflareTunnel]() {id, account\_tag, config\_src, 10 more } GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} ##### [Create a Cloudflare Tunnel](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/create) client.zeroTrust.tunnels.cloudflared.create(CloudflaredCreateParams {account\_id, name, config\_src, tunnel\_secret } params, RequestOptionsoptions?): [CloudflareTunnel]() {id, account\_tag, config\_src, 10 more } POST/accounts/{account\_id}/cfd\_tunnel ##### [Update a Cloudflare Tunnel](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/edit) client.zeroTrust.tunnels.cloudflared.edit(stringtunnelID, CloudflaredEditParams {account\_id, name, tunnel\_secret } params, RequestOptionsoptions?): [CloudflareTunnel]() {id, account\_tag, config\_src, 10 more } PATCH/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} ##### [Delete a Cloudflare Tunnel](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/delete) client.zeroTrust.tunnels.cloudflared.delete(stringtunnelID, CloudflaredDeleteParams {account\_id } params, RequestOptionsoptions?): [CloudflareTunnel]() {id, account\_tag, config\_src, 10 more } DELETE/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} #### TunnelsCloudflaredConfigurations ##### [Get Tunnel configuration](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/configurations/methods/get) client.zeroTrust.tunnels.cloudflared.configurations.get(stringtunnelID, ConfigurationGetParams {account\_id } params, RequestOptionsoptions?): [ConfigurationGetResponse]() {account\_id, config, created\_at, 3 more } GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/configurations ##### [Update Tunnel configuration](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/configurations/methods/update) client.zeroTrust.tunnels.cloudflared.configurations.update(stringtunnelID, ConfigurationUpdateParams {account\_id, config } params, RequestOptionsoptions?): [ConfigurationUpdateResponse]() {account\_id, config, created\_at, 3 more } PUT/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/configurations ##### ModelsExpand Collapse
ConfigurationGetResponse {account\_id, config, created\_at, 3 more } Cloudflare Tunnel configuration account\_id?: string Identifier. maxLength32 Link to this property
config?: Config {ingress, originRequest } The tunnel configuration and ingress rules.
ingress?: Array<Ingress> List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel. hostname: string Public hostname for this service. Link to this property service: 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’. Link to this property
originRequest?: OriginRequest {access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access?: Access {audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. audTag: Array<string> 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. Link to this property teamName: string Link to this property required?: boolean Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property caPool?: string 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. Link to this property connectTimeout?: number Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout. Link to this property disableChunkedEncoding?: boolean Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2Origin?: boolean Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property httpHostHeader?: string Sets the HTTP Host header on requests sent to the local service. Link to this property keepAliveConnections?: number Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. Link to this property keepAliveTimeout?: number Timeout after which an idle keepalive connection can be discarded. Link to this property matchSNItoHost?: boolean Auto configure the Hostname on the origin server certificate. Link to this property noHappyEyeballs?: boolean Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property noTLSVerify?: boolean Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property originServerName?: string Hostname that cloudflared should expect from your origin server certificate. Link to this property proxyType?: 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. Link to this property tcpKeepAlive?: number The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tlsTimeout?: number Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. Link to this property
Link to this property path?: string Requests with this path route to this public hostname. Link to this property
Link to this property
originRequest?: OriginRequest {access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access?: Access {audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. audTag: Array<string> 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. Link to this property teamName: string Link to this property required?: boolean Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property caPool?: string 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. Link to this property connectTimeout?: number Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout. Link to this property disableChunkedEncoding?: boolean Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2Origin?: boolean Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property httpHostHeader?: string Sets the HTTP Host header on requests sent to the local service. Link to this property keepAliveConnections?: number Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. Link to this property keepAliveTimeout?: number Timeout after which an idle keepalive connection can be discarded. Link to this property matchSNItoHost?: boolean Auto configure the Hostname on the origin server certificate. Link to this property noHappyEyeballs?: boolean Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property noTLSVerify?: boolean Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property originServerName?: string Hostname that cloudflared should expect from your origin server certificate. Link to this property proxyType?: 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. Link to this property tcpKeepAlive?: number The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tlsTimeout?: number Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. Link to this property
Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
source?: "local"| "cloudflare" Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel’s configuration on the Zero Trust dashboard. One of the following: "local" Link to this property "cloudflare" Link to this property
Link to this property tunnel\_id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property version?: number The version of the Tunnel Configuration. Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.configurations%20%3E%20(model)%20configuration_get_response%20%3E%20(schema)>)
ConfigurationUpdateResponse {account\_id, config, created\_at, 3 more } Cloudflare Tunnel configuration account\_id?: string Identifier. maxLength32 Link to this property
config?: Config {ingress, originRequest } The tunnel configuration and ingress rules.
ingress?: Array<Ingress> List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel. hostname: string Public hostname for this service. Link to this property service: 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’. Link to this property
originRequest?: OriginRequest {access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access?: Access {audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. audTag: Array<string> 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. Link to this property teamName: string Link to this property required?: boolean Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property caPool?: string 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. Link to this property connectTimeout?: number Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout. Link to this property disableChunkedEncoding?: boolean Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2Origin?: boolean Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property httpHostHeader?: string Sets the HTTP Host header on requests sent to the local service. Link to this property keepAliveConnections?: number Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. Link to this property keepAliveTimeout?: number Timeout after which an idle keepalive connection can be discarded. Link to this property matchSNItoHost?: boolean Auto configure the Hostname on the origin server certificate. Link to this property noHappyEyeballs?: boolean Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property noTLSVerify?: boolean Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property originServerName?: string Hostname that cloudflared should expect from your origin server certificate. Link to this property proxyType?: 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. Link to this property tcpKeepAlive?: number The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tlsTimeout?: number Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. Link to this property
Link to this property path?: string Requests with this path route to this public hostname. Link to this property
Link to this property
originRequest?: OriginRequest {access, caPool, connectTimeout, 12 more } Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access?: Access {audTag, teamName, required } For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. audTag: Array<string> 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. Link to this property teamName: string Link to this property required?: boolean Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property caPool?: string 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. Link to this property connectTimeout?: number Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout. Link to this property disableChunkedEncoding?: boolean Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2Origin?: boolean Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property httpHostHeader?: string Sets the HTTP Host header on requests sent to the local service. Link to this property keepAliveConnections?: number Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections. Link to this property keepAliveTimeout?: number Timeout after which an idle keepalive connection can be discarded. Link to this property matchSNItoHost?: boolean Auto configure the Hostname on the origin server certificate. Link to this property noHappyEyeballs?: boolean Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property noTLSVerify?: boolean Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property originServerName?: string Hostname that cloudflared should expect from your origin server certificate. Link to this property proxyType?: 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. Link to this property tcpKeepAlive?: number The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tlsTimeout?: number Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server. Link to this property
Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
source?: "local"| "cloudflare" Indicates if this is a locally or remotely configured tunnel. If local, manage the tunnel using a YAML file on the origin machine. If cloudflare, manage the tunnel’s configuration on the Zero Trust dashboard. One of the following: "local" Link to this property "cloudflare" Link to this property
Link to this property tunnel\_id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property version?: number The version of the Tunnel Configuration. Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.configurations%20%3E%20(model)%20configuration_update_response%20%3E%20(schema)>) #### TunnelsCloudflaredConnections ##### [List Cloudflare Tunnel connections](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connections/methods/get) client.zeroTrust.tunnels.cloudflared.connections.get(stringtunnelID, ConnectionGetParams {account\_id } params, RequestOptionsoptions?): SinglePage< [Client]() {id, arch, config\_version, 4 more } > GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connections ##### [Clean up Cloudflare Tunnel connections](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connections/methods/delete) client.zeroTrust.tunnels.cloudflared.connections.delete(stringtunnelID, ConnectionDeleteParams {account\_id, client\_id } params, RequestOptionsoptions?): [ConnectionDeleteResponse]()| null DELETE/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connections ##### ModelsExpand Collapse
Client {id, arch, config\_version, 4 more } A client (typically cloudflared) that maintains connections to a Cloudflare data center. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property arch?: string The cloudflared OS architecture used to establish this connection. Link to this property config\_version?: number The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard. Link to this property
conns?: Array<Conn> The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property features?: Array<string> Features enabled for the Cloudflare Tunnel. Link to this property run\_at?: string Timestamp of when the tunnel connection was started. formatdate-time Link to this property version?: string The cloudflared version used to establish this connection. Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.connections%20%3E%20(model)%20client%20%3E%20(schema)>) ConnectionDeleteResponse = unknown [Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.connections%20%3E%20(model)%20connection_delete_response%20%3E%20(schema)>) #### TunnelsCloudflaredToken ##### [Get a Cloudflare Tunnel token](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/token/methods/get) client.zeroTrust.tunnels.cloudflared.token.get(stringtunnelID, TokenGetParams {account\_id } params, RequestOptionsoptions?): [TokenGetResponse]() GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/token ##### ModelsExpand Collapse TokenGetResponse = string The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. [Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.token%20%3E%20(model)%20token_get_response%20%3E%20(schema)>) #### TunnelsCloudflaredConnectors ##### [Get Cloudflare Tunnel connector](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connectors/methods/get) client.zeroTrust.tunnels.cloudflared.connectors.get(stringconnectorID, ConnectorGetParams {account\_id, tunnel\_id } params, RequestOptionsoptions?): [Client]() {id, arch, config\_version, 4 more } GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connectors/{connector\_id} #### TunnelsCloudflaredManagement ##### [Get a Cloudflare Tunnel management token](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/management/methods/create) client.zeroTrust.tunnels.cloudflared.management.create(stringtunnelID, ManagementCreateParams {account\_id, resources } params, RequestOptionsoptions?): [ManagementCreateResponse]() POST/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/management ##### ModelsExpand Collapse ManagementCreateResponse = string The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. [Link to this property](<#(resource)%20zero_trust.tunnels.cloudflared.management%20%3E%20(model)%20management_create_response%20%3E%20(schema)>) #### TunnelsWARP Connector ##### [List Mesh nodes](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/list) client.zeroTrust.tunnels.warpConnector.list(WARPConnectorListParams {account\_id, exclude\_prefix, existed\_at, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray< [WARPConnectorListResponse]() {id, account\_tag, connections, 8 more } > GET/accounts/{account\_id}/warp\_connector ##### [Get a Mesh node](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/get) client.zeroTrust.tunnels.warpConnector.get(stringtunnelID, WARPConnectorGetParams {account\_id } params, RequestOptionsoptions?): [WARPConnectorGetResponse]() {id, account\_tag, connections, 8 more } GET/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### [Create a Mesh node](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/create) client.zeroTrust.tunnels.warpConnector.create(WARPConnectorCreateParams {account\_id, name, ha } params, RequestOptionsoptions?): [WARPConnectorCreateResponse]() {id, account\_tag, connections, 8 more } POST/accounts/{account\_id}/warp\_connector ##### [Update a Mesh node](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/edit) client.zeroTrust.tunnels.warpConnector.edit(stringtunnelID, WARPConnectorEditParams {account\_id, name, tunnel\_secret } params, RequestOptionsoptions?): [WARPConnectorEditResponse]() {id, account\_tag, connections, 8 more } PATCH/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### [Delete a Mesh node](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/delete) client.zeroTrust.tunnels.warpConnector.delete(stringtunnelID, WARPConnectorDeleteParams {account\_id } params, RequestOptionsoptions?): [WARPConnectorDeleteResponse]() {id, account\_tag, connections, 8 more } DELETE/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### ModelsExpand Collapse
WARPConnectorListResponse {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector%20%3E%20(model)%20warp_connector_list_response%20%3E%20(schema)>)
WARPConnectorGetResponse {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector%20%3E%20(model)%20warp_connector_get_response%20%3E%20(schema)>)
WARPConnectorCreateResponse {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector%20%3E%20(model)%20warp_connector_create_response%20%3E%20(schema)>)
WARPConnectorEditResponse {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector%20%3E%20(model)%20warp_connector_edit_response%20%3E%20(schema)>)
WARPConnectorDeleteResponse {id, account\_tag, connections, 8 more } A Mesh node that connects your origin to Cloudflare’s edge. id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag?: string Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections?: Array<Connection> This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint /accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect?: boolean This functionality has been removed. The is\_pending\_reconnect field will now always report false. Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running cloudflared. Link to this property uuid?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at?: string Timestamp of when the tunnel established at least one connection to Cloudflare’s edge. If null, the tunnel is inactive. formatdate-time Link to this property conns\_inactive\_at?: string Timestamp of when the tunnel became inactive (no connections to Cloudflare’s edge). If null, the tunnel is active. formatdate-time Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata?: unknown Metadata associated with the tunnel. Link to this property name?: string A user-friendly name for a tunnel. Link to this property
status?: "inactive"| "degraded"| "healthy"| "down" The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). One of the following: "inactive" Link to this property "degraded" Link to this property "healthy" Link to this property "down" Link to this property
Link to this property
tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel. One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property
Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector%20%3E%20(model)%20warp_connector_delete_response%20%3E%20(schema)>) #### TunnelsWARP ConnectorToken ##### [Get a Mesh node token](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/token/methods/get) client.zeroTrust.tunnels.warpConnector.token.get(stringtunnelID, TokenGetParams {account\_id } params, RequestOptionsoptions?): [TokenGetResponse]() GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/token ##### ModelsExpand Collapse TokenGetResponse = string The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel. [Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.token%20%3E%20(model)%20token_get_response%20%3E%20(schema)>) #### TunnelsWARP ConnectorConnections ##### [List Mesh node connections](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/connections/methods/get) client.zeroTrust.tunnels.warpConnector.connections.get(stringtunnelID, ConnectionGetParams {account\_id } params, RequestOptionsoptions?): SinglePage< [ConnectionGetResponse]() {id, arch, conns, 4 more } > GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/connections ##### ModelsExpand Collapse
ConnectionGetResponse {id, arch, conns, 4 more } A Mesh node connector that maintains a connection to a Cloudflare data center. id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property arch?: string The cloudflared OS architecture used to establish this connection. Link to this property
conns?: Array<Conn> The Mesh node connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running the Mesh node connector. Link to this property
Link to this property features?: Array<string> Features enabled for the Cloudflare Tunnel. Link to this property
ha\_status?: "offline"| "passive"| "active" The HA status of a Mesh node connector. One of the following: "offline" Link to this property "passive" Link to this property "active" Link to this property
Link to this property run\_at?: string Timestamp of when the tunnel connection was started. formatdate-time Link to this property version?: string The cloudflared version used to establish this connection. Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.connections%20%3E%20(model)%20connection_get_response%20%3E%20(schema)>) #### TunnelsWARP ConnectorConnectors ##### [Get a Mesh node connector](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/connectors/methods/get) client.zeroTrust.tunnels.warpConnector.connectors.get(stringconnectorID, ConnectorGetParams {account\_id, tunnel\_id } params, RequestOptionsoptions?): [ConnectorGetResponse]() {id, arch, conns, 4 more } GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/connectors/{connector\_id} ##### ModelsExpand Collapse
ConnectorGetResponse {id, arch, conns, 4 more } A Mesh node connector that maintains a connection to a Cloudflare data center. id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property arch?: string The cloudflared OS architecture used to establish this connection. Link to this property
conns?: Array<Conn> The Mesh node connections between your origin and Cloudflare’s edge. id?: string UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id?: string UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version?: string The cloudflared version used to establish this connection. Link to this property colo\_name?: string The Cloudflare data center used for this connection. Link to this property opened\_at?: string Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip?: string The public IP address of the host running the Mesh node connector. Link to this property
Link to this property features?: Array<string> Features enabled for the Cloudflare Tunnel. Link to this property
ha\_status?: "offline"| "passive"| "active" The HA status of a Mesh node connector. One of the following: "offline" Link to this property "passive" Link to this property "active" Link to this property
Link to this property run\_at?: string Timestamp of when the tunnel connection was started. formatdate-time Link to this property version?: string The cloudflared version used to establish this connection. Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.connectors%20%3E%20(model)%20connector_get_response%20%3E%20(schema)>) #### TunnelsWARP ConnectorFailover ##### [Trigger a manual failover for a Mesh node](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/failover/methods/update) client.zeroTrust.tunnels.warpConnector.failover.update(stringtunnelID, FailoverUpdateParams {account\_id, client\_id } params, RequestOptionsoptions?): [FailoverUpdateResponse]()| null PUT/accounts/{account\_id}/warp\_connector/{tunnel\_id}/failover ##### ModelsExpand Collapse FailoverUpdateResponse = unknown [Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.failover%20%3E%20(model)%20failover_update_response%20%3E%20(schema)>) #### TunnelsWARP ConnectorConfigurations ##### [Get Mesh node HA configuration](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/configurations/methods/get) client.zeroTrust.tunnels.warpConnector.configurations.get(stringtunnelID, ConfigurationGetParams {account\_id } params, RequestOptionsoptions?): [ConfigurationGetResponse]() {configuration\_version, created\_at, ha\_mode, 3 more } GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/configurations ##### [Update Mesh node HA configuration](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/configurations/methods/update) client.zeroTrust.tunnels.warpConnector.configurations.update(stringtunnelID, ConfigurationUpdateParams {account\_id, ha\_mode, config } params, RequestOptionsoptions?): [ConfigurationUpdateResponse]() {configuration\_version, created\_at, ha\_mode, 3 more } PUT/accounts/{account\_id}/warp\_connector/{tunnel\_id}/configurations ##### ModelsExpand Collapse
ConfigurationGetResponse {configuration\_version, created\_at, ha\_mode, 3 more } configuration\_version: number Monotonically increasing configuration version, incremented on each PUT. Link to this property created\_at: string Timestamp of when the resource was created. formatdate-time Link to this property
ha\_mode: "none"| "disabled"| "aws"| "local" High-availability mode for the Mesh node. none means HA is enabled but no provider is configured yet (newly created nodes default to this). disabled means HA is explicitly turned off. aws uses AWS ENI move for failover. local uses virtual IPs (VIPs) on the local interface. One of the following: "none" Link to this property "disabled" Link to this property "aws" Link to this property "local" Link to this property
Link to this property tunnel\_id: string UUID of the tunnel. formatuuid maxLength36 Link to this property
config?: TunnelMeshAwsConfig {fnr\_id } | TunnelMeshLocalConfig {vips, vips\_previous } | null Provider-specific configuration. Present for aws and local modes. One of the following:
TunnelMeshAwsConfig {fnr\_id } fnr\_id: string Floating Network Resource ID — the secondary ENI that is moved between nodes on failover. Link to this property
Link to this property
TunnelMeshLocalConfig {vips, vips\_previous }
vips: Array<Vip> VIPs to assign on the CloudflareWARP interface. address: string Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
vips\_previous?: Array<VipsPrevious> VIPs to clean up on demotion or version drift. address: string Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
Link to this property
Link to this property updated\_at?: string| null Timestamp of the last update. Null if never updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.configurations%20%3E%20(model)%20configuration_get_response%20%3E%20(schema)>)
ConfigurationUpdateResponse {configuration\_version, created\_at, ha\_mode, 3 more } configuration\_version: number Monotonically increasing configuration version, incremented on each PUT. Link to this property created\_at: string Timestamp of when the resource was created. formatdate-time Link to this property
ha\_mode: "none"| "disabled"| "aws"| "local" High-availability mode for the Mesh node. none means HA is enabled but no provider is configured yet (newly created nodes default to this). disabled means HA is explicitly turned off. aws uses AWS ENI move for failover. local uses virtual IPs (VIPs) on the local interface. One of the following: "none" Link to this property "disabled" Link to this property "aws" Link to this property "local" Link to this property
Link to this property tunnel\_id: string UUID of the tunnel. formatuuid maxLength36 Link to this property
config?: TunnelMeshAwsConfig {fnr\_id } | TunnelMeshLocalConfig {vips, vips\_previous } | null Provider-specific configuration. Present for aws and local modes. One of the following:
TunnelMeshAwsConfig {fnr\_id } fnr\_id: string Floating Network Resource ID — the secondary ENI that is moved between nodes on failover. Link to this property
Link to this property
TunnelMeshLocalConfig {vips, vips\_previous }
vips: Array<Vip> VIPs to assign on the CloudflareWARP interface. address: string Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
vips\_previous?: Array<VipsPrevious> VIPs to clean up on demotion or version drift. address: string Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
Link to this property
Link to this property updated\_at?: string| null Timestamp of the last update. Null if never updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20zero_trust.tunnels.warp_connector.configurations%20%3E%20(model)%20configuration_update_response%20%3E%20(schema)>)