--- title: Tunnels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Zero Trust](https://developers.cloudflare.com/api/python/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/python/resources/zero_trust/subresources/tunnels/methods/list) zero\_trust.tunnels.list(TunnelListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[TunnelListResponse]()] GET/accounts/{account\_id}/tunnels ##### ModelsExpand Collapse
TunnelListResponse A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. One of the following:
class CloudflareTunnel: … A Cloudflare Tunnel that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
config\_src: Optional\[Literal\["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: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property Deprecatedremote\_config: Optional\[bool] 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: Optional\[Literal\["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: Optional\[Literal\["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
class TunnelWARPConnectorTunnel: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[TunnelWARPConnectorTunnelConnection]] 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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/list) zero\_trust.tunnels.cloudflared.list(CloudflaredListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[CloudflareTunnel]()] GET/accounts/{account\_id}/cfd\_tunnel ##### [Get a Cloudflare Tunnel](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/get) zero\_trust.tunnels.cloudflared.get(strtunnel\_id, CloudflaredGetParams\*\*kwargs) -> [CloudflareTunnel]() GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} ##### [Create a Cloudflare Tunnel](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/create) zero\_trust.tunnels.cloudflared.create(CloudflaredCreateParams\*\*kwargs) -> [CloudflareTunnel]() POST/accounts/{account\_id}/cfd\_tunnel ##### [Update a Cloudflare Tunnel](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/edit) zero\_trust.tunnels.cloudflared.edit(strtunnel\_id, CloudflaredEditParams\*\*kwargs) -> [CloudflareTunnel]() PATCH/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} ##### [Delete a Cloudflare Tunnel](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/methods/delete) zero\_trust.tunnels.cloudflared.delete(strtunnel\_id, CloudflaredDeleteParams\*\*kwargs) -> [CloudflareTunnel]() DELETE/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id} #### TunnelsCloudflaredConfigurations ##### [Get Tunnel configuration](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/configurations/methods/get) zero\_trust.tunnels.cloudflared.configurations.get(strtunnel\_id, ConfigurationGetParams\*\*kwargs) -> [ConfigurationGetResponse]() GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/configurations ##### [Update Tunnel configuration](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/configurations/methods/update) zero\_trust.tunnels.cloudflared.configurations.update(strtunnel\_id, ConfigurationUpdateParams\*\*kwargs) -> [ConfigurationUpdateResponse]() PUT/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/configurations ##### ModelsExpand Collapse
class ConfigurationGetResponse: … Cloudflare Tunnel configuration account\_id: Optional\[str] Identifier. maxLength32 Link to this property
config: Optional\[Config] The tunnel configuration and ingress rules.
ingress: Optional\[List\[ConfigIngress]] List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel. hostname: str Public hostname for this service. Link to this property service: str 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
origin\_request: Optional\[ConfigIngressOriginRequest] Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: Optional\[ConfigIngressOriginRequestAccess] For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. aud\_tag: List\[str] 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 team\_name: str Link to this property required: Optional\[bool] Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property ca\_pool: Optional\[str] 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 connect\_timeout: Optional\[int] 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 disable\_chunked\_encoding: Optional\[bool] Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2\_origin: Optional\[bool] Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property http\_host\_header: Optional\[str] Sets the HTTP Host header on requests sent to the local service. Link to this property keep\_alive\_connections: Optional\[int] 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 keep\_alive\_timeout: Optional\[int] Timeout after which an idle keepalive connection can be discarded. Link to this property match\_sn\_ito\_host: Optional\[bool] Auto configure the Hostname on the origin server certificate. Link to this property no\_happy\_eyeballs: Optional\[bool] Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property no\_tls\_verify: Optional\[bool] Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property origin\_server\_name: Optional\[str] Hostname that cloudflared should expect from your origin server certificate. Link to this property proxy\_type: Optional\[str] 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 tcp\_keep\_alive: Optional\[int] The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tls\_timeout: Optional\[int] 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: Optional\[str] Requests with this path route to this public hostname. Link to this property
Link to this property
origin\_request: Optional\[ConfigOriginRequest] Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: Optional\[ConfigOriginRequestAccess] For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. aud\_tag: List\[str] 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 team\_name: str Link to this property required: Optional\[bool] Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property ca\_pool: Optional\[str] 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 connect\_timeout: Optional\[int] 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 disable\_chunked\_encoding: Optional\[bool] Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2\_origin: Optional\[bool] Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property http\_host\_header: Optional\[str] Sets the HTTP Host header on requests sent to the local service. Link to this property keep\_alive\_connections: Optional\[int] 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 keep\_alive\_timeout: Optional\[int] Timeout after which an idle keepalive connection can be discarded. Link to this property match\_sn\_ito\_host: Optional\[bool] Auto configure the Hostname on the origin server certificate. Link to this property no\_happy\_eyeballs: Optional\[bool] Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property no\_tls\_verify: Optional\[bool] Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property origin\_server\_name: Optional\[str] Hostname that cloudflared should expect from your origin server certificate. Link to this property proxy\_type: Optional\[str] 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 tcp\_keep\_alive: Optional\[int] The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tls\_timeout: Optional\[int] 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: Optional\[datetime] formatdate-time Link to this property
source: Optional\[Literal\["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: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property version: Optional\[int] 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)>)
class ConfigurationUpdateResponse: … Cloudflare Tunnel configuration account\_id: Optional\[str] Identifier. maxLength32 Link to this property
config: Optional\[Config] The tunnel configuration and ingress rules.
ingress: Optional\[List\[ConfigIngress]] List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel. hostname: str Public hostname for this service. Link to this property service: str 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
origin\_request: Optional\[ConfigIngressOriginRequest] Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: Optional\[ConfigIngressOriginRequestAccess] For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. aud\_tag: List\[str] 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 team\_name: str Link to this property required: Optional\[bool] Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property ca\_pool: Optional\[str] 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 connect\_timeout: Optional\[int] 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 disable\_chunked\_encoding: Optional\[bool] Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2\_origin: Optional\[bool] Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property http\_host\_header: Optional\[str] Sets the HTTP Host header on requests sent to the local service. Link to this property keep\_alive\_connections: Optional\[int] 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 keep\_alive\_timeout: Optional\[int] Timeout after which an idle keepalive connection can be discarded. Link to this property match\_sn\_ito\_host: Optional\[bool] Auto configure the Hostname on the origin server certificate. Link to this property no\_happy\_eyeballs: Optional\[bool] Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property no\_tls\_verify: Optional\[bool] Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property origin\_server\_name: Optional\[str] Hostname that cloudflared should expect from your origin server certificate. Link to this property proxy\_type: Optional\[str] 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 tcp\_keep\_alive: Optional\[int] The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tls\_timeout: Optional\[int] 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: Optional\[str] Requests with this path route to this public hostname. Link to this property
Link to this property
origin\_request: Optional\[ConfigOriginRequest] Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.
access: Optional\[ConfigOriginRequestAccess] For all L7 requests to this hostname, cloudflared will validate each request’s Cf-Access-Jwt-Assertion request header. aud\_tag: List\[str] 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 team\_name: str Link to this property required: Optional\[bool] Deny traffic that has not fulfilled Access authorization. Link to this property
Link to this property ca\_pool: Optional\[str] 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 connect\_timeout: Optional\[int] 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 disable\_chunked\_encoding: Optional\[bool] Disables chunked transfer encoding. Useful if you are running a WSGI server. Link to this property http2\_origin: Optional\[bool] Attempt to connect to origin using HTTP2. Origin must be configured as https. Link to this property http\_host\_header: Optional\[str] Sets the HTTP Host header on requests sent to the local service. Link to this property keep\_alive\_connections: Optional\[int] 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 keep\_alive\_timeout: Optional\[int] Timeout after which an idle keepalive connection can be discarded. Link to this property match\_sn\_ito\_host: Optional\[bool] Auto configure the Hostname on the origin server certificate. Link to this property no\_happy\_eyeballs: Optional\[bool] Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols. Link to this property no\_tls\_verify: Optional\[bool] Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted. Link to this property origin\_server\_name: Optional\[str] Hostname that cloudflared should expect from your origin server certificate. Link to this property proxy\_type: Optional\[str] 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 tcp\_keep\_alive: Optional\[int] The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server. Link to this property tls\_timeout: Optional\[int] 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: Optional\[datetime] formatdate-time Link to this property
source: Optional\[Literal\["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: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property version: Optional\[int] 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/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connections/methods/get) zero\_trust.tunnels.cloudflared.connections.get(strtunnel\_id, ConnectionGetParams\*\*kwargs) -> SyncSinglePage\[[Client]()] GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connections ##### [Clean up Cloudflare Tunnel connections](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connections/methods/delete) zero\_trust.tunnels.cloudflared.connections.delete(strtunnel\_id, ConnectionDeleteParams\*\*kwargs) -> object DELETE/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connections ##### ModelsExpand Collapse
class Client: … A client (typically cloudflared) that maintains connections to a Cloudflare data center. id: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property arch: Optional\[str] The cloudflared OS architecture used to establish this connection. Link to this property config\_version: Optional\[int] The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard. Link to this property
conns: Optional\[List\[Conn]] The Cloudflare Tunnel connections between your origin and Cloudflare’s edge. id: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property features: Optional\[List\[str]] Features enabled for the Cloudflare Tunnel. Link to this property run\_at: Optional\[datetime] Timestamp of when the tunnel connection was started. formatdate-time Link to this property version: Optional\[str] 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)>) #### TunnelsCloudflaredToken ##### [Get a Cloudflare Tunnel token](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/token/methods/get) zero\_trust.tunnels.cloudflared.token.get(strtunnel\_id, TokenGetParams\*\*kwargs) -> [TokenGetResponse]() GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/token ##### ModelsExpand Collapse str 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/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/connectors/methods/get) zero\_trust.tunnels.cloudflared.connectors.get(strconnector\_id, ConnectorGetParams\*\*kwargs) -> [Client]() GET/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/connectors/{connector\_id} #### TunnelsCloudflaredManagement ##### [Get a Cloudflare Tunnel management token](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/cloudflared/subresources/management/methods/create) zero\_trust.tunnels.cloudflared.management.create(strtunnel\_id, ManagementCreateParams\*\*kwargs) -> [ManagementCreateResponse]() POST/accounts/{account\_id}/cfd\_tunnel/{tunnel\_id}/management ##### ModelsExpand Collapse str 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/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/list) zero\_trust.tunnels.warp\_connector.list(WARPConnectorListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[WARPConnectorListResponse]()] GET/accounts/{account\_id}/warp\_connector ##### [Get a Mesh node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/get) zero\_trust.tunnels.warp\_connector.get(strtunnel\_id, WARPConnectorGetParams\*\*kwargs) -> [WARPConnectorGetResponse]() GET/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### [Create a Mesh node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/create) zero\_trust.tunnels.warp\_connector.create(WARPConnectorCreateParams\*\*kwargs) -> [WARPConnectorCreateResponse]() POST/accounts/{account\_id}/warp\_connector ##### [Update a Mesh node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/edit) zero\_trust.tunnels.warp\_connector.edit(strtunnel\_id, WARPConnectorEditParams\*\*kwargs) -> [WARPConnectorEditResponse]() PATCH/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### [Delete a Mesh node](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/methods/delete) zero\_trust.tunnels.warp\_connector.delete(strtunnel\_id, WARPConnectorDeleteParams\*\*kwargs) -> [WARPConnectorDeleteResponse]() DELETE/accounts/{account\_id}/warp\_connector/{tunnel\_id} ##### ModelsExpand Collapse
class WARPConnectorListResponse: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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)>)
class WARPConnectorGetResponse: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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)>)
class WARPConnectorCreateResponse: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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)>)
class WARPConnectorEditResponse: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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)>)
class WARPConnectorDeleteResponse: … A Mesh node that connects your origin to Cloudflare’s edge. id: Optional\[str] UUID of the tunnel. formatuuid maxLength36 Link to this property account\_tag: Optional\[str] Cloudflare account ID maxLength32 Link to this property
Deprecatedconnections: Optional\[List\[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: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property Deprecatedis\_pending\_reconnect: Optional\[bool] 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: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running cloudflared. Link to this property uuid: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property
Link to this property conns\_active\_at: Optional\[datetime] 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: Optional\[datetime] 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: Optional\[datetime] Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at: Optional\[datetime] Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property metadata: Optional\[object] Metadata associated with the tunnel. Link to this property name: Optional\[str] A user-friendly name for a tunnel. Link to this property
status: Optional\[Literal\["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: Optional\[Literal\["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/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/token/methods/get) zero\_trust.tunnels.warp\_connector.token.get(strtunnel\_id, TokenGetParams\*\*kwargs) -> [TokenGetResponse]() GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/token ##### ModelsExpand Collapse str 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/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/connections/methods/get) zero\_trust.tunnels.warp\_connector.connections.get(strtunnel\_id, ConnectionGetParams\*\*kwargs) -> SyncSinglePage\[[ConnectionGetResponse]()] GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/connections ##### ModelsExpand Collapse
class ConnectionGetResponse: … A Mesh node connector that maintains a connection to a Cloudflare data center. id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property arch: Optional\[str] The cloudflared OS architecture used to establish this connection. Link to this property
conns: Optional\[List\[Conn]] The Mesh node connections between your origin and Cloudflare’s edge. id: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property opened\_at: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running the Mesh node connector. Link to this property
Link to this property features: Optional\[List\[str]] Features enabled for the Cloudflare Tunnel. Link to this property
ha\_status: Optional\[Literal\["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: Optional\[datetime] Timestamp of when the tunnel connection was started. formatdate-time Link to this property version: Optional\[str] 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/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/connectors/methods/get) zero\_trust.tunnels.warp\_connector.connectors.get(strconnector\_id, ConnectorGetParams\*\*kwargs) -> [ConnectorGetResponse]() GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/connectors/{connector\_id} ##### ModelsExpand Collapse
class ConnectorGetResponse: … A Mesh node connector that maintains a connection to a Cloudflare data center. id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property arch: Optional\[str] The cloudflared OS architecture used to establish this connection. Link to this property
conns: Optional\[List\[Conn]] The Mesh node connections between your origin and Cloudflare’s edge. id: Optional\[str] UUID of the Cloudflare Tunnel connection. formatuuid maxLength36 Link to this property client\_id: Optional\[str] UUID of the Cloudflare Tunnel connector. formatuuid maxLength36 Link to this property client\_version: Optional\[str] The cloudflared version used to establish this connection. Link to this property colo\_name: Optional\[str] The Cloudflare data center used for this connection. Link to this property opened\_at: Optional\[datetime] Timestamp of when the connection was established. formatdate-time Link to this property origin\_ip: Optional\[str] The public IP address of the host running the Mesh node connector. Link to this property
Link to this property features: Optional\[List\[str]] Features enabled for the Cloudflare Tunnel. Link to this property
ha\_status: Optional\[Literal\["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: Optional\[datetime] Timestamp of when the tunnel connection was started. formatdate-time Link to this property version: Optional\[str] 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/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/failover/methods/update) zero\_trust.tunnels.warp\_connector.failover.update(strtunnel\_id, FailoverUpdateParams\*\*kwargs) -> object PUT/accounts/{account\_id}/warp\_connector/{tunnel\_id}/failover #### TunnelsWARP ConnectorConfigurations ##### [Get Mesh node HA configuration](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/configurations/methods/get) zero\_trust.tunnels.warp\_connector.configurations.get(strtunnel\_id, ConfigurationGetParams\*\*kwargs) -> [ConfigurationGetResponse]() GET/accounts/{account\_id}/warp\_connector/{tunnel\_id}/configurations ##### [Update Mesh node HA configuration](https://developers.cloudflare.com/api/python/resources/zero_trust/subresources/tunnels/subresources/warp_connector/subresources/configurations/methods/update) zero\_trust.tunnels.warp\_connector.configurations.update(strtunnel\_id, ConfigurationUpdateParams\*\*kwargs) -> [ConfigurationUpdateResponse]() PUT/accounts/{account\_id}/warp\_connector/{tunnel\_id}/configurations ##### ModelsExpand Collapse
class ConfigurationGetResponse: … configuration\_version: int Monotonically increasing configuration version, incremented on each PUT. Link to this property created\_at: datetime Timestamp of when the resource was created. formatdate-time Link to this property
ha\_mode: Literal\["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: str UUID of the tunnel. formatuuid maxLength36 Link to this property
config: Optional\[Config] Provider-specific configuration. Present for aws and local modes. One of the following:
class ConfigTunnelMeshAwsConfig: … fnr\_id: str Floating Network Resource ID — the secondary ENI that is moved between nodes on failover. Link to this property
Link to this property
class ConfigTunnelMeshLocalConfig: …
vips: List\[ConfigTunnelMeshLocalConfigVip] VIPs to assign on the CloudflareWARP interface. address: str Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
vips\_previous: Optional\[List\[ConfigTunnelMeshLocalConfigVipsPrevious]] VIPs to clean up on demotion or version drift. address: str Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
Link to this property
Link to this property updated\_at: Optional\[datetime] 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)>)
class ConfigurationUpdateResponse: … configuration\_version: int Monotonically increasing configuration version, incremented on each PUT. Link to this property created\_at: datetime Timestamp of when the resource was created. formatdate-time Link to this property
ha\_mode: Literal\["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: str UUID of the tunnel. formatuuid maxLength36 Link to this property
config: Optional\[Config] Provider-specific configuration. Present for aws and local modes. One of the following:
class ConfigTunnelMeshAwsConfig: … fnr\_id: str Floating Network Resource ID — the secondary ENI that is moved between nodes on failover. Link to this property
Link to this property
class ConfigTunnelMeshLocalConfig: …
vips: List\[ConfigTunnelMeshLocalConfigVip] VIPs to assign on the CloudflareWARP interface. address: str Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
vips\_previous: Optional\[List\[ConfigTunnelMeshLocalConfigVipsPrevious]] VIPs to clean up on demotion or version drift. address: str Virtual IP address (IPv4 or IPv6). Link to this property
Link to this property
Link to this property
Link to this property updated\_at: Optional\[datetime] 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)>)