---
title: "Get region by ID"
slug: "get-region-by-id"
updated: 2026-02-18T12:52:40Z
published: 2026-02-18T12:52:58Z
canonical: "support.perimeter81.com/get-region-by-id"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.perimeter81.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get region by ID

Get/v2.3/networks/{networkId}/regions/{regionId}

Required permissions: `[&quot;network:read&quot;]` Get Region.

SecurityHTTPType bearer

Path parametersnetworkIdstringRequired
regionIdstringRequired

Responses200

Completed successfully

<select class='api-response-data' aria-label='Media type'><option value='9090d1e6-6e26-4079-85cd-3763ade95f3b'>application/json</option>
</select>Expand Allobject  createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

networkstring    

ID of the network.

dnsstring    

DNS of the region.

namestring    

Name of the network region.

instances Array of object (NetworkInstance)   

Network instances.

object  createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

networkstring    

ID of the network.

regionstring    

ID of the network region.

instanceTypestring    
imageTypestring    
imageVersionstring    
dnsstring    
ipstring    
tunnels Array of object (NetworkTunnel)   

List of network tunnels.

AnyOfobjectobjectidstring    

Unique ID.

networkstring    

ID of the network.

regionstring    

ID of the network region.

instancestring    

ID of the network instance.

interfaceNamestring    
typestring    Valid values[
  "connector",
  "ipsec",
  "openvpn"
]
isHAboolean    

Indicates if it's a redundant tunnel.

tenantIdstring    

ID of the tenant.

createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

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

Openvpn username.

objectobjectidstring    

Unique ID.

networkstring    

ID of the network.

regionstring    

ID of the network region.

instancestring    

ID of the network instance.

interfaceNamestring    
typestring    Valid values[
  "connector",
  "ipsec",
  "openvpn"
]
isHAboolean    

Indicates if it's a redundant tunnel.

tenantIdstring    

ID of the tenant.

createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

leftAllowedIP Array of string   Min length1string    
leftEndpointstring  (ipv4)    
vaultstring    

vault.

requestConfigTokenstring    

requestConfigToken.

objectobjectidstring    

Unique ID.

networkstring    

ID of the network.

regionstring    

ID of the network region.

instancestring    

ID of the network instance.

interfaceNamestring    
typestring    Valid values[
  "connector",
  "ipsec",
  "openvpn"
]
isHAboolean    

Indicates if it's a redundant tunnel.

tenantIdstring    

ID of the tenant.

createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

keyExchangestring    Valid values[
  "ikev1",
  "ikev2"
]
ikeLifeTimestring    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)$
lifetimestring    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)$
dpdDelaystring    Pattern^([5-9]|[1-5][0-9]|60)s$
dpdTimeoutstring    Pattern^([5-9]|[1-5][0-9]|60)s$
phase1object  auth Array of string   Min length1string    Valid values[
  "md5",
  "sha1",
  "sha384",
  "sha256",
  "sha512",
  "aesxcbc",
  "aescmac",
  "prfmd5",
  "prfsha1",
  "prfaesxcbc",
  "prfaescmac",
  "prfsha256",
  "prfsha384",
  "prfsha512"
]
encryption Array of string   Min length1string    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 length0integer    Valid values[
  2,
  5,
  14,
  19,
  20,
  21,
  31
]

phase2object  auth Array of string   Min length1string    Valid values[
  "md5",
  "sha1",
  "sha384",
  "sha256",
  "sha512",
  "aesxcbc",
  "aescmac",
  "prfmd5",
  "prfsha1",
  "prfaesxcbc",
  "prfaescmac",
  "prfsha256",
  "prfsha384",
  "prfsha512"
]
encryption Array of string   Min length1string    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 length0integer    Valid values[
  2,
  5,
  14,
  19,
  20,
  21,
  31
]

rightstring  (ipv4)    
rightIDOneOfstring (ipv4)string
stringstringPattern^[a-zA-Z0-9]{3,25}$

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

dpdAction.

leftSubnets Array of string   Min length1string    
rightSubnets Array of string   Min length1string    

objectobjectidstring    

Unique ID.

networkstring    

ID of the network.

regionstring    

ID of the network region.

instancestring    

ID of the network instance.

interfaceNamestring    
typestring    Valid values[
  "connector",
  "ipsec",
  "openvpn"
]
isHAboolean    

Indicates if it's a redundant tunnel.

tenantIdstring    

ID of the tenant.

createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

keyExchangestring    Valid values[
  "ikev1",
  "ikev2"
]
ikeLifeTimestring    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)$
lifetimestring    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)$
dpdDelaystring    Pattern^([5-9]|[1-5][0-9]|60)s$
dpdTimeoutstring    Pattern^([5-9]|[1-5][0-9]|60)s$
phase1object  auth Array of string   Min length1string    Valid values[
  "md5",
  "sha1",
  "sha384",
  "sha256",
  "sha512",
  "aesxcbc",
  "aescmac",
  "prfmd5",
  "prfsha1",
  "prfaesxcbc",
  "prfaescmac",
  "prfsha256",
  "prfsha384",
  "prfsha512"
]
encryption Array of string   Min length1string    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 length0integer    Valid values[
  2,
  5,
  14,
  19,
  20,
  21,
  31
]

phase2object  auth Array of string   Min length1string    Valid values[
  "md5",
  "sha1",
  "sha384",
  "sha256",
  "sha512",
  "aesxcbc",
  "aescmac",
  "prfmd5",
  "prfsha1",
  "prfaesxcbc",
  "prfaescmac",
  "prfsha256",
  "prfsha384",
  "prfsha512"
]
encryption Array of string   Min length1string    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 length0integer    Valid values[
  2,
  5,
  14,
  19,
  20,
  21,
  31
]

rightstring  (ipv4)    
rightIDOneOfstring (ipv4)string
stringstringPattern^[a-zA-Z0-9]{3,25}$

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

dpdAction.

leftSubnets Array of string   Min length1string    
rightSubnets Array of string   Min length1string    
haTunnelIDobject  createdAtstring  (date-time)    

The date when this record was created.

updatedAtstring  (date-time)    

The date of last update of the record.

networkstring    

ID of the network.

tunnels Array of string   string    
typestring    Patternipsec
tenantIdstring    

tenantId.

idstring    

id.

rightASNinteger  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.

OneOfintegerintegerMinimum1Maximum64496
integerintegerMinimum64512Maximum65535
integerintegerMinimum131072Maximum4294967295

rightPrivateIPstring  (ipv4)    
leftPrivateIPstring  (ipv4)    

idstring    

Unique ID.

tenantIdstring    

ID of the tenant.

idstring    

Unique ID.

tenantIdstring    

ID of the tenant.

401

Unauthorized

403

Forbidden

404

Region not found
