/v1/gateways/reference-consumer

Prev Next
Get
/v1/gateways/reference-consumer

Get the priorly-configured IPSec gateway details for a customer, lan segment, region combination to be re-used for any new service matches for that customer with the given lan segment and region

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Responses
200

OK

Expand All
object
ipsecGatewayDetails
object (manaV2IPsecGatewayDetails)
destinationAddress
string
Exampleexample string
ikeInitiator
boolean
Exampletrue
mtu
integer (int32)
Minimum0
Example123
name
string
Exampleexample string
remoteIkePeerIdentity
string
Exampleexample string
routing
object (manaV2IpsecRoutingConfig)
bgp
object (manaV2IPsecBgpRouteConfig)
addressFamilies
object
property*
object (manaV2NullableBgpNeighborAddressFamilyConfig) additionalProperties
family
object (manaV2BgpNeighborAddressFamilyConfig)
addressFamily
string
ExampleENUM_VALUE
inboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
outboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
holdTimer
integer (int32)
Minimum0
Example123
keepaliveTimer
integer (int32)
Minimum0
Example123
md5Password
object (manaV2NullableMd5Password)
md5Password
string
Exampleexample string
peerAsn
integer (int32)
Minimum0
Example123
sendCommunity
boolean
Exampletrue
static
object (manaV2IPsecStaticRouteConfig)
destinationPrefix
Array of string
string
Exampleexample string
tcpMss
integer (int32)
Minimum0
Example123
tunnel1
object (manaV2IPsecGatewayTunnelDetails)
insideIpv4Cidr
string
Exampleexample string
insideIpv6Cidr
string
Exampleexample string
localIkePeerIdentity
string
Exampleexample string
psk
string
Exampleexample string
tunnel2
object (manaV2IPsecGatewayTunnelDetails)
insideIpv4Cidr
string
Exampleexample string
insideIpv6Cidr
string
Exampleexample string
localIkePeerIdentity
string
Exampleexample string
psk
string
Exampleexample string
vpnProfile
string
Exampleexample string
ipsecGatewayPeers
object (manaV2IPsecGatewayPeersConfig)
name
string

Name of the IPsec gateway service

Exampleexample string
remotePeers
Array of object (manaV2IPsecGatewayRemotePeer)
object
destinationAddress
string
Exampleexample string
ikeInitiator
boolean

When true, Graphiant initiates IKE for this peer

Exampletrue
mtu
integer (int32)
Minimum0
Example123
name
string

Optional display name or label for this peer; used when generating tunnel names

Exampleexample string
remoteIkePeerIdentity
string

IKE identity of the remote peer

Exampleexample string
tcpMss
integer (int32)
Minimum0
Example123
tunnel1
object (manaV2IPsecGatewayTunnelDetails)
insideIpv4Cidr
string
Exampleexample string
insideIpv6Cidr
string
Exampleexample string
localIkePeerIdentity
string
Exampleexample string
psk
string
Exampleexample string
tunnel2
object (manaV2IPsecGatewayTunnelDetails)
insideIpv4Cidr
string
Exampleexample string
insideIpv6Cidr
string
Exampleexample string
localIkePeerIdentity
string
Exampleexample string
psk
string
Exampleexample string
vpnProfile
string

Enterprise IPsec VPN profile name for this peer

Exampleexample string
routing
object (manaV2IpsecRoutingConfig)
bgp
object (manaV2IPsecBgpRouteConfig)
addressFamilies
object
property*
object (manaV2NullableBgpNeighborAddressFamilyConfig) additionalProperties
family
object (manaV2BgpNeighborAddressFamilyConfig)
addressFamily
string
ExampleENUM_VALUE
inboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
outboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
holdTimer
integer (int32)
Minimum0
Example123
keepaliveTimer
integer (int32)
Minimum0
Example123
md5Password
object (manaV2NullableMd5Password)
md5Password
string
Exampleexample string
peerAsn
integer (int32)
Minimum0
Example123
sendCommunity
boolean
Exampletrue
static
object (manaV2IPsecStaticRouteConfig)
destinationPrefix
Array of string
string
Exampleexample string