POST
Create a site-to-site connection

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid
string
required

VPC UUID

Body

application/json

Create a site-to-site connection

name
string
required

Connection name, unique within the gateway. Lowercase letters, numbers and hyphens, 2 to 30 characters. This is the name the platform addresses the tunnel by.

remote_cidrs
string[]
required

The far side's IPv4 ranges, e.g. ['10.0.0.0/16']. Anything outside them is not routed over the tunnel.

tunnels
object[]
required

One entry per tunnel from the far side's configuration. AWS gives two; only the first is used today, because running both needs a guest-kernel roll that has not happened yet.

peer_asn
integer<int32>

The far side's BGP ASN, when it runs BGP

Response

Create a site-to-site connection

Api_V1_Entities_SiteConnection model

uuid
string
required

Unique connection identifier

name
string
required

Connection name, unique within the gateway

peer_kind
string
required

Far side's platform. Only aws today

peer_asn
integer<int32>
required

Far side's BGP ASN, when it runs BGP

remote_cidrs
any[]
required

The far side's IPv4 ranges

remote_gateways
any[]
required

Addresses of the far side's tunnel endpoints. The pre-shared keys sent alongside them are never returned

status
string
required

Current status (pending, active, failed, deleting)

public_ip
string
required

The public IPv4 this connection holds exclusively. Enter it on the far side

created_at
string<date-time>
required

Creation timestamp