Get
/v2.3/networks/{networkId}/tunnels/ipsec/single/{tunnelId}
Required permissions: ["network:read"]
Security
HTTP
Type bearer
Path parameters
networkId
stringRequired
tunnelId
stringRequired
Responses
200
Success
object
tunnelID
string
regionID
string
Region ID
gatewayID
string
Gateway ID
tunnelName
string
The name of the tunnel
Min length3
Max length15
Pattern^[a-zA-Z0-9]*$
p81GatewaySubnets
Array of string
Min length1
string
remoteGatewaySubnets
Array of string
Min length1
string
peakBandwidth
integer
Expected peak throughput of the tunnel communication in Mbps. Typical connection will be of 1000Mbps.
Minimum10
Maximum8000
Default1000
p81ASN
integer #deprecatedtemplate# #additional-property-template#
OneOf
integer
integer
Minimum1
Maximum23455
integer
integer
Minimum23457
Maximum64495
integer
integer
Minimum64512
Maximum65534
integer
integer
Minimum131072
Maximum4294967294
features
object
symmetricInnerMesh
object
enabled
boolean
Defaultfalse
keyExchange
string
Valid values[
"ikev1",
"ikev2"
]
ikeLifeTime
string
Pattern^((1[0-9]|[2-9][0-9]|[1-9][0-9]{2,3}|[1-7][0-9]{4}|8[0-5][0-9]{3}|86[0-3][0-9]{2}|86400)s)|(([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-3][0-9][0-9]|14[0-3][0-9]|1440)m)|(([1-9]|1[0-9]|2[0-4])h)$
lifetime
string
Pattern^((1[0-9]|[2-9][0-9]|[1-9][0-9]{2,3}|[1-7][0-9]{4}|8[0-5][0-9]{3}|86[0-3][0-9]{2}|86400)s)|(([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-3][0-9][0-9]|14[0-3][0-9]|1440)m)|(([1-9]|1[0-9]|2[0-4])h)$
dpdDelay
string
Pattern^([5-9]|[1-5][0-9]|60)s$
dpdTimeout
string
Pattern^([5-9]|[1-5][0-9]|60)s$
phase1
object
auth
Array of string
Min length1
string
Valid values[
"md5",
"sha1",
"sha384",
"sha256",
"sha512",
"aesxcbc",
"aescmac",
"prfmd5",
"prfsha1",
"prfaesxcbc",
"prfaescmac",
"prfsha256",
"prfsha384",
"prfsha512"
]
encryption
Array of string
Min length1
string
Valid values[
"3des",
"blowfish128",
"blowfish192",
"blowfish256",
"aes128",
"aes192",
"aes256",
"aes128ctr",
"aes192ctr",
"aes256ctr",
"camellia128",
"camellia192",
"camellia256",
"camellia128ctr",
"camellia192ctr",
"camellia256ctr",
"aes128ccm8",
"aes192ccm8",
"aes256ccm8",
"aes128ccm16",
"aes192ccm16",
"aes256ccm16",
"aes128gcm8",
"aes192gcm8",
"aes256gcm8",
"aes128gcm16",
"aes192gcm16",
"aes256gcm16",
"camellia128ccm16",
"camellia192ccm16",
"camellia256ccm16",
"chacha20poly1305"
]
dh
Array of integer
Diffie Helman encryption
Min length0
integer
Valid values[
2,
5,
14,
19,
20,
21,
31
]
phase2
object
auth
Array of string
Min length1
string
Valid values[
"md5",
"sha1",
"sha384",
"sha256",
"sha512",
"aesxcbc",
"aescmac",
"prfmd5",
"prfsha1",
"prfaesxcbc",
"prfaescmac",
"prfsha256",
"prfsha384",
"prfsha512"
]
encryption
Array of string
Min length1
string
Valid values[
"3des",
"blowfish128",
"blowfish192",
"blowfish256",
"aes128",
"aes192",
"aes256",
"aes128ctr",
"aes192ctr",
"aes256ctr",
"camellia128",
"camellia192",
"camellia256",
"camellia128ctr",
"camellia192ctr",
"camellia256ctr",
"aes128ccm8",
"aes192ccm8",
"aes256ccm8",
"aes128ccm16",
"aes192ccm16",
"aes256ccm16",
"aes128gcm8",
"aes192gcm8",
"aes256gcm8",
"aes128gcm16",
"aes192gcm16",
"aes256gcm16",
"camellia128ccm16",
"camellia192ccm16",
"camellia256ccm16",
"chacha20poly1305"
]
dh
Array of integer
Diffie Helman encryption
Min length0
integer
Valid values[
2,
5,
14,
19,
20,
21,
31
]
passphrase
string
Pattern^[a-zA-Z1-9._][a-zA-Z0-9._]{7,63}$
remotePublicIP
string (ipv4)
remoteID
OneOf
string (ipv4)
string
string
string
Pattern^[a-zA-Z0-9]{3,25}$
createdAt
string (date-time)
The date when this record was created.
updatedAt
string (date-time)
The date of last update of the record.
type
string
Default"ipsec"
401
Unauthorized
object
id
string
message
string
403
Forbidden
object
id
string
message
string
404
Resource not found
object
id
string
message
string