Cosmic Domain Admin API Reference

createVpnCustomerGateway

Creates site to site vpn customer gateway

Request parameters

Parameter NameDescriptionRequired
cidrlistguest cidr list of the customer gatewaytrue
esppolicyESP policy of the customer gatewaytrue
gatewaypublic ip address id of the customer gatewaytrue
ikepolicyIKE policy of the customer gatewaytrue
ipsecpskIPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.true
accountthe account associated with the gateway. Must be used with the domainId parameter.false
domainidthe domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.false
dpdIf DPD is enabled for VPN connectionfalse
esplifetimeLifetime of phase 2 VPN connection to the customer gateway, in secondsfalse
forceencapForce Encapsulation for NAT traversalfalse
ikelifetimeLifetime of phase 1 VPN connection to the customer gateway, in secondsfalse
namename of this customer gatewayfalse
projectidcreate site-to-site VPN customer gateway for the projectfalse

Response Tags

Response NameDescription
idthe vpn gateway ID
accountthe owner
cidrlistguest cidr list of the customer gateway
domainthe domain name of the owner
domainidthe domain id of the owner
dpdif DPD is enabled for customer gateway
esplifetimeLifetime of ESP SA of customer gateway
esppolicyIPsec policy of customer gateway
forceencapif Force NAT Encapsulation is enabled for customer gateway
gatewaypublic ip address id of the customer gateway
ikelifetimeLifetime of IKE SA of customer gateway
ikepolicyIKE policy of customer gateway
ipaddressguest ip of the customer gateway
ipsecpskIPsec preshared-key of customer gateway
namename of the customer gateway
projectthe project name
projectidthe project id
removedthe date and time the host was removed