/v1/gateways/guest-consumer/{matchId}

Prev Next
Get
/v1/gateways/guest-consumer/{matchId}

Get Site to Site VPN information for a non-Graphiant guest consumer by their email

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Path parameters
matchId
integer (int64) Required
Example1234567891011
Query parameters
email
string
Exampleexample string
Responses
200

OK

Expand All
object
destinationPrefixes
Array of string
string
Exampleexample string
ipsecTunnelConfig
Array of object (v1GatewaysGuestConsumerMatchIdGetResponseIpsecVpnTunnelConfig)
object
bgpGraphiantAsn
integer (int32)
Minimum0
Example123
bgpLocalAsn
integer (int32)
Minimum0
Example123
bgpNeighborHoldTime
integer (int32)
Minimum0
Example123
bgpNeighborIpv4
string
Exampleexample string
bgpNeighborIpv6
string
Exampleexample string
dpdInterval
integer (int32)
Minimum0
Example123
dpdRetries
integer (int32)
Minimum0
Example123
graphiantDestinationIp
string
Exampleexample string
graphiantIkeId
string
Exampleexample string
graphiantOuterTunnelIp
string
Exampleexample string
graphiantTunnelIp
string
Exampleexample string
graphiantTunnelIpv6
string
Exampleexample string
ikeAuthenticationAlgorithm
string
Exampleexample string
ikeAuthenticationMethod
string
Exampleexample string
ikeDhAlgorithm
string
Exampleexample string
ikeEncryptionAlgorithm
string
Exampleexample string
ikeLifetime
string
Exampleexample string
ikePresharedKey
string
Exampleexample string
ikeVersion
integer (int32)
Example123
ipsecAuthenticationAlgorithm
string
Exampleexample string
ipsecEncryptionAlgorithm
string
Exampleexample string
ipsecExtendedSequenceNumber
boolean
Exampletrue
ipsecLifetime
string
Exampleexample string
ipsecMode
string
Exampleexample string
ipsecPfsAlgorithm
string
Exampleexample string
ipsecProtocol
string
Exampleexample string
localIkeId
string
Exampleexample string
localOuterTunnelIp
string
Exampleexample string
localTunnelIp
string
Exampleexample string
localTunnelIpv6
string
Exampleexample string
tcpMss
integer (int32)
Minimum0
Example123
tunnelMtu
integer (int32)
Minimum0
Example123
siteToSiteVpn
object (manaV2GuestConsumerSiteToSiteVpnConfig)
emails
Array of string
string
Exampleexample string
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
regionId
integer (int32)
Example123