List connections
List all your connections. A number of filters are available, including Project ID, name, tags and status.
path Parameters
regionThe region you want to target
query Parameters
pagePage number to return.
page_sizeMaximum number of connections to return per page.
order_byOrder in which to return results.
project_idProject ID to filter for. (UUID format)
organization_idOrganization ID to filter for. (UUID format)
nameConnection name to filter for.
tagsTags to filter for.
Connection statuses to filter for.
is_ipv6Filter connections with IP version of IPSec tunnel.
routing_policy_idsFilter for connections using these routing policies.
route_propagation_enabledFilter for connections with route propagation enabled.
vpn_gateway_idsFilter for connections attached to these VPN gateways.
customer_gateway_idsFilter for connections attached to these customer gateways.
List connections › Responses
List of connections on the current page.
total_countTotal number of connections.
Create a connection
path Parameters
regionThe region you want to target
Create a connection › Request Body
project_idID of the Project to create the connection in. (UUID format)
nameName of the connection.
initiation_policyWho initiates the IPsec tunnel.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
vpn_gateway_idID of the VPN gateway to attach to the connection. (UUID format)
customer_gateway_idID of the customer gateway to attach to the connection. (UUID format)
tagsList of tags to apply to the connection.
is_ipv6Defines IP version of the IPSec Tunnel.
enable_route_propagationDefines whether route propagation is enabled or not.
BGP config of IPv4 session, including interco private IPv4 subnet (first IP assigned to the VPN Gateway, second IP to the Customer Gateway) and attached routing policy.
BGP config of IPv6 session, including interco private IPv6 subnet (first IP assigned to the VPN Gateway, second IP to the Customer Gateway) and attached routing policy.
Create a connection › Responses
This connection.
pre_shared_keyNew PSK generated for this connection. Deprecated, use secret_id & secret_revision fields.
Get a connection
Get a connection for the given connection ID. The response object includes information about the connection's various configuration details.
path Parameters
regionThe region you want to target
connection_idID of the requested connection. (UUID format)
Get a connection › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.
Delete a connection
Delete an existing connection, specified by its connection ID.
path Parameters
regionThe region you want to target
connection_idID of the connection to delete. (UUID format)
Delete a connection › Responses
Update a connection
Update an existing connection, specified by its connection ID.
path Parameters
regionThe region you want to target
connection_idID of the connection to update. (UUID format)
Update a connection › Request Body
nameName of the connection.
tagsList of tags to apply to the connection.
initiation_policyWho initiates the IPsec tunnel.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
Update a connection › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.
Detach a routing policy
Detach an existing routing policy from a connection, specified by its connection ID.
path Parameters
regionThe region you want to target
connection_idID of the connection from which routing policy is being detached. (UUID format)
Detach a routing policy › Request Body
routing_policy_v4ID of the routing policy to detach from the BGP IPv4 session. (UUID format)
routing_policy_v6ID of the routing policy to detach from the BGP IPv6 session. (UUID format)
Detach a routing policy › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.
Disable route propagation
Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the VPN Gateway until route propagation is re-enabled.
path Parameters
regionThe region you want to target
connection_idID of the connection on which to disable route propagation. (UUID format)
Disable route propagation › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.
Enable route propagation
Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
path Parameters
regionThe region you want to target
connection_idID of the connection on which to enable route propagation. (UUID format)
Enable route propagation › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.
Renew pre-shared key
Renew pre-shared key for a given connection.
path Parameters
regionThe region you want to target
connection_idID of the connection to renew the PSK. (UUID format)
Renew pre-shared key › Responses
This connection.
pre_shared_keyNew PSK generated for this connection. Deprecated, use secret_id & secret_revision fields.
Set a new routing policy
Set a new routing policy on a connection, overriding the existing one if present, specified by its connection ID.
path Parameters
regionThe region you want to target
connection_idID of the connection whose routing policy is being updated. (UUID format)
Set a new routing policy › Request Body
routing_policy_v4ID of the routing policy to set for the BGP IPv4 session. (UUID format)
routing_policy_v6ID of the routing policy to set for the BGP IPv6 session. (UUID format)
Set a new routing policy › Responses
idUnique identifier of the connection. (UUID format)
project_idProject ID. (UUID format)
organization_idOrganization ID. (UUID format)
nameName of the connection.
tagsList of tags applied to the connection.
created_atCreation date of the connection. (RFC 3339 format)
updated_atLast modification date of the connection. (RFC 3339 format)
statusStatus of the connection.
is_ipv6IP version of the IPSec Tunnel.
initiation_policyWho initiates the IPsec tunnel.
secret_idID of the secret in Secret Manager which contains the PSK. (UUID format)
secret_revisionVersion number of the secret in Secret Manager which contains the PSK.
List of IKE v2 ciphers proposed for the IPsec tunnel.
List of ESP ciphers proposed for the IPsec tunnel.
route_propagation_enabledDefines whether route propagation is enabled or not.
vpn_gateway_idID of the VPN gateway attached to the connection. (UUID format)
customer_gateway_idID of the customer gateway attached to the connection. (UUID format)
tunnel_statusStatus of the IPsec tunnel.
bgp_status_ipv4Status of the BGP IPv4 session.
bgp_status_ipv6Status of the BGP IPv6 session.
BGP IPv4 session, including status, interco private IPv4 subnet and attached routing policy.
BGP IPv6 session, including status, interco private IPv6 subnet and attached routing policy.
regionRegion of the connection.
tunnel_status_ipv4Status of the IPv4 IPsec tunnel.
tunnel_status_ipv6Status of the IPv6 IPsec tunnel.