/v1/gateways

Prev Next
Put
/v1/gateways
Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Body parameters
Expand All
object
details
object (manaV2GatewayDetails)
aws
object (manaV2AwsGatewayDetails)
accountId
string
Exampleexample string
advanceSettings
object (manaV2AwsAdvanceSettings)
addressFamily
string
ExampleENUM_VALUE
allowedPrefixes
Array of string
string
Exampleexample string
amazonBgpRouterIp
string
Exampleexample string
bgpAuthKey
string
Exampleexample string
customerBgpRouterIp
string
Exampleexample string
isJumbo
boolean
Exampletrue
transitConnection
object (manaV2AWSGatewayDetailsTransitConnection)
credentials
object (manaV2AwsCredentials)
accessKeyId
string
Exampleexample string
secretAccessKey
string
Exampleexample string
customerAsn
integer (int32)
Minimum0
Example123
gateway
object (manaV2AwsDirectConnectGateway)
asn
integer (int32)
Minimum0
Example123
id
string
Exampleexample string
name
string
Exampleexample string
transitGateways
Array of object (manaV2AwsTransitGateway)
object
asn
integer (int32)
Minimum0
Example123
id
string
Exampleexample string
vpcs
Array of object (manaV2AWSTransitGatewayVpc)
object
id
string
Exampleexample string
subnets
Array of object (manaV2Subnet)
object
cidr
string
Exampleexample string
id
string
Exampleexample string
region
string
Exampleexample string
azure
object (manaV2AzureGatewayDetails)
msPeeringVlanId
integer (int32)
Minimum0
Example123
routingPolicy
string
Exampleexample string
serviceKey
string
Exampleexample string
description
string
Exampleexample string
gcp
object (manaV2GcpGatewayDetails)
description
string
Exampleexample string
pairingKey
string
Exampleexample string
routingPolicy
string
Exampleexample string
ipsecGateway
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
oci
object (manaV2OciGatewayDetails)
description
string
Exampleexample string
fastConnectOcid
string
Exampleexample string
routingPolicy
string
Exampleexample string
regionId
integer (int32)
Example123
speed
string
ExampleENUM_VALUE
vrfId
integer (int64)
Example1234567891011
id
integer (int64)
Example1234567891011
Responses
200

OK

object