Stage a peer route
Records that an IPv4 range on the far side of a terminator should be reachable from inside the VPC.
Staging changes nothing yet. The route is created with status pending and reaches the cluster only when you call the apply endpoint, which restarts every attached workload — so add all the ranges you need first and pay that price once.
Every gateway kind is accepted, but only Cloudflare WARP and Tailscale normally need a route — WireGuard’s client pool and an IPsec connection’s remote selectors are derived by the platform from the gateways themselves. A route naming a gateway that is not running is dropped rather than installed, because pointing the router at it would blackhole the traffic instead of letting it take the default path.
Authorizations
Bearer token for authentication. Format: 'Bearer {token}'
Headers
Workspace ID (uses default workspace if not provided)
Path Parameters
VPC UUID
Body
Stage a peer route
IPv4 range on the far side, e.g. 192.168.10.0/24. Unique within the VPC.
Terminator the range sits behind. In practice only cloudflare and tailscale need a route: WireGuard's client pool and an IPsec connection's remote selectors are derived from the gateways themselves and added automatically.
wireguard, cloudflare, ipsec, tailscale, egress Free-text note, e.g. what lives in that range
Response
Stage a peer route
Api_V1_Entities_VpcPeerRoute model
Unique route identifier
IPv4 range reachable through the gateway
Terminator the range sits behind: cloudflare or tailscale
Free-text note
pending until applied, then applied or failed
Creation timestamp

