API Reference

Zero Trust

Tunnels

WARP Connector

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Configurations

Get WARP Connector HA configuration

zero_trust.tunnels.warp_connector.configurations.get(strtunnel_id, ConfigurationGetParams**kwargs) -> ConfigurationGetResponse

GET/accounts/{account_id}/warp_connector/{tunnel_id}/configurations

Update WARP Connector HA configuration

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.

created_at: datetime

Timestamp of when the resource was created.

formatdate-time

ha_mode: Literal["none", "disabled", "aws", "local"]

High-availability mode for the WARP Connector tunnel. none means HA is enabled but no provider is configured yet (newly created tunnels 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"

"disabled"

"aws"

"local"

tunnel_id: str

UUID of the tunnel.

formatuuid

maxLength36

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.

class ConfigTunnelMeshLocalConfig: …

vips: List[ConfigTunnelMeshLocalConfigVip]

VIPs to assign on the CloudflareWARP interface.

address: str

Virtual IP address (IPv4 or IPv6).

vips_previous: Optional[List[ConfigTunnelMeshLocalConfigVipsPrevious]]

VIPs to clean up on demotion or version drift.

address: str

Virtual IP address (IPv4 or IPv6).

updated_at: Optional[datetime]

Timestamp of the last update. Null if never updated.

formatdate-time

class ConfigurationUpdateResponse: …

configuration_version: int

Monotonically increasing configuration version, incremented on each PUT.

created_at: datetime

Timestamp of when the resource was created.

formatdate-time

ha_mode: Literal["none", "disabled", "aws", "local"]

High-availability mode for the WARP Connector tunnel. none means HA is enabled but no provider is configured yet (newly created tunnels 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"

"disabled"

"aws"

"local"

tunnel_id: str

UUID of the tunnel.

formatuuid

maxLength36

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.

class ConfigTunnelMeshLocalConfig: …

vips: List[ConfigTunnelMeshLocalConfigVip]

VIPs to assign on the CloudflareWARP interface.

address: str

Virtual IP address (IPv4 or IPv6).

vips_previous: Optional[List[ConfigTunnelMeshLocalConfigVipsPrevious]]

VIPs to clean up on demotion or version drift.

address: str

Virtual IP address (IPv4 or IPv6).

updated_at: Optional[datetime]

Timestamp of the last update. Null if never updated.

formatdate-time