Perimeter81 Public API

Get network by Id

22 Nov 2023
3 Minutes to read
Contributors

Get network by Id

Updated on 22 Nov 2023
3 Minutes to read
Contributors

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/v2/networks/{networkId}

Required permissions: ["network:read"]

List network.

Security

Http

Type bearer

Path parameters

networkId

stringRequired

Responses

200

Completed successfully

Expand All

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.

string

Unique ID.

tenantId

string

ID of the tenant.

asn

integer

Maximum65534

Minimum64510

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

tunnels

Array of object (NetworkTunnel)

List of network tunnels.

AnyOf

object

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

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

string

leftEndpoint

string (ipv4)

vault

string

vault.

requestConfigToken

string

requestConfigToken.

object

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 (IPSecPhase)

auth

Array of string

string

Valid values[ "3des", "blowfish128", "blowfish192", "blowfish256", "aes128", "aes192", "aes256" ]

encryption

Array of string

string

Valid values[ "md5", "sha1", "sha384", "sha256", "sha512" ]

Array of integer

Diffie Helman encryption

integer

Valid values[ 2, 5, 14, 19, 20, 21 ]

phase2

object (IPSecPhase)

auth

Array of string

string

Valid values[ "3des", "blowfish128", "blowfish192", "blowfish256", "aes128", "aes192", "aes256" ]

encryption

Array of string

string

Valid values[ "md5", "sha1", "sha384", "sha256", "sha512" ]

Array of integer

Diffie Helman encryption

integer

Valid values[ 2, 5, 14, 19, 20, 21 ]

right

string (ipv4)

rightID

OneOf

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

string

rightSubnets

Array of string

string

object

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 (IPSecPhase)

auth

Array of string

string

Valid values[ "3des", "blowfish128", "blowfish192", "blowfish256", "aes128", "aes192", "aes256" ]

encryption

Array of string

string

Valid values[ "md5", "sha1", "sha384", "sha256", "sha512" ]

Array of integer

Diffie Helman encryption

integer

Valid values[ 2, 5, 14, 19, 20, 21 ]

phase2

object (IPSecPhase)

auth

Array of string

string

Valid values[ "3des", "blowfish128", "blowfish192", "blowfish256", "aes128", "aes192", "aes256" ]

encryption

Array of string

string

Valid values[ "md5", "sha1", "sha384", "sha256", "sha512" ]

Array of integer

Diffie Helman encryption

integer

Valid values[ 2, 5, 14, 19, 20, 21 ]

right

string (ipv4)

rightID

OneOf

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

string

rightSubnets

Array of string

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.

string

id.

rightASN

integer

Maximum65534

Minimum64510

rightPrivateIP

string (ipv4)

leftPrivateIP

string (ipv4)

string

Unique ID.

tenantId

string

ID of the tenant.

string

Unique ID.

tenantId

string

ID of the tenant.

401

Unauthorized

403

Forbidden

404

Network not found

Was this article helpful?

What's Next

Create network