Get all Networks

  • Updated on Nov 12, 2025
  • Published on Nov 5, 2025
  • 4 minute(s) read
  • Perimeter Support
 Prev Next
Get
/v2.3/networks

List all networks

Security
HTTP
Type bearer
Responses
200

Success

Array of object

Network list.

object
createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

dns
string

DNS of the network.

subnet
string

Subnet of the network.

accessType
string
Valid values[ "public", "private" ]
applications
Array of string

List of IDs of assigned applications.

string
tags
Array of string

List of network tags.

string
name
string

Network name.

isDefault
boolean

Indicates that the network is default.

id
string

Unique ID.

tenantId
string

ID of the tenant.

asn
integer

Autonomous System Number (ASN) for BGP routing. It will be automatically assigned an ASN once creating the first dynamic tunnel in this network. The network ASN can never be changed once it is set.

OneOf
integer
integer
Minimum1
Maximum64496
integer
integer
Minimum64512
Maximum65535
integer
integer
Minimum131072
Maximum4294967295
regions
Array of object (NetworkRegion)

Network regions list.

object
createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

network
string

ID of the network.

dns
string

DNS of the region.

name
string

Name of the network region.

instances
Array of object (NetworkInstance)

Network instances.

object
createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

network
string

ID of the network.

region
string

ID of the network region.

instanceType
string
imageType
string
imageVersion
string
dns
string
ip
string
tunnels
Array of object (NetworkTunnel)

List of network tunnels.

AnyOf
object
object
id
string

Unique ID.

network
string

ID of the network.

region
string

ID of the network region.

instance
string

ID of the network instance.

interfaceName
string
type
string
Valid values[ "connector", "ipsec", "openvpn" ]
isHA
boolean

Indicates if it's a redundant tunnel.

tenantId
string

ID of the tenant.

createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

passphrase
string
Pattern^[$a-zA-Z1-9_\/\.][$a-zA-Z0-9_\/\.]{7,101}$
username
string

Openvpn username.

object
object
id
string

Unique ID.

network
string

ID of the network.

region
string

ID of the network region.

instance
string

ID of the network instance.

interfaceName
string
type
string
Valid values[ "connector", "ipsec", "openvpn" ]
isHA
boolean

Indicates if it's a redundant tunnel.

tenantId
string

ID of the tenant.

createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

leftAllowedIP
Array of string
Min length1
string
leftEndpoint
string (ipv4)
vault
string

vault.

requestConfigToken
string

requestConfigToken.

object
object
id
string

Unique ID.

network
string

ID of the network.

region
string

ID of the network region.

instance
string

ID of the network instance.

interfaceName
string
type
string
Valid values[ "connector", "ipsec", "openvpn" ]
isHA
boolean

Indicates if it's a redundant tunnel.

tenantId
string

ID of the tenant.

createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

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 ]
right
string (ipv4)
rightID
OneOf
string (ipv4)
string
string
string
Pattern^[a-zA-Z0-9]{3,25}$
passphrase
string
Pattern^[$a-zA-Z1-9_\/\.][$a-zA-Z0-9_\/\.]{7,101}$
dpdAction
string

dpdAction.

leftSubnets
Array of string
Min length1
string
rightSubnets
Array of string
Min length1
string
object
object
id
string

Unique ID.

network
string

ID of the network.

region
string

ID of the network region.

instance
string

ID of the network instance.

interfaceName
string
type
string
Valid values[ "connector", "ipsec", "openvpn" ]
isHA
boolean

Indicates if it's a redundant tunnel.

tenantId
string

ID of the tenant.

createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

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 ]
right
string (ipv4)
rightID
OneOf
string (ipv4)
string
string
string
Pattern^[a-zA-Z0-9]{3,25}$
passphrase
string
Pattern^[$a-zA-Z1-9_\/\.][$a-zA-Z0-9_\/\.]{7,101}$
dpdAction
string

dpdAction.

leftSubnets
Array of string
Min length1
string
rightSubnets
Array of string
Min length1
string
haTunnelID
object
createdAt
string (date-time)

The date when this record was created.

updatedAt
string (date-time)

The date of last update of the record.

network
string

ID of the network.

tunnels
Array of string
string
type
string
Patternipsec
tenantId
string

tenantId.

id
string

id.

rightASN
integer Required

Autonomous System Number (ASN) for BGP routing. It will be automatically assigned an ASN once creating the first dynamic tunnel in this network. The network ASN can never be changed once it is set.

OneOf
integer
integer
Minimum1
Maximum64496
integer
integer
Minimum64512
Maximum65535
integer
integer
Minimum131072
Maximum4294967295
rightPrivateIP
string (ipv4)
leftPrivateIP
string (ipv4)
id
string

Unique ID.

tenantId
string

ID of the tenant.

id
string

Unique ID.

tenantId
string

ID of the tenant.

401

Unauthorized

403

Forbbiden