Skip to content

Get a single cloud-vpn-connection by id

GET
/cloud-vpn-connections/{id}
id
required
string

DocumentId

OK

object
data
object
name
required
string
peer_address
required
string
peer_cidr
required
string
psk_encrypted
string
bgp_asn
integer
state
string
Allowed values: pending available deleting deleted failed
external_id
string
metadata

Arbitrary JSON value (object, array, string, number, boolean, or null)

vpn_gateway
One of:

DocumentId reference to api::cloud-vpn-gateway.cloud-vpn-gateway

string
organisation
One of:

DocumentId reference to api::organisation.organisation

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found