Get region by ID
  • 22 Nov 2023
  • 3 Minutes to read
  • Contributors

    Get region by ID


      Article summary

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

      Required permissions: ["network:read"]

      Get Region.

      Security
      Http
      Type bearer
      Path parameters
      networkId
      stringRequired
      regionId
      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.

      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
      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
      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
      string
      leftEndpoint
      string (ipv4)
      vault
      string

      vault.

      requestConfigToken
      string

      requestConfigToken.

      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 (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" ]
      dh
      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" ]
      dh
      Array of integer

      Diffie Helman encryption

      integer
      Valid values[ 2, 5, 14, 19, 20, 21 ]
      right
      string (ipv4)
      rightID
      OneOf
      string
      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
      string
      rightSubnets
      Array of string
      string
      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 (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" ]
      dh
      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" ]
      dh
      Array of integer

      Diffie Helman encryption

      integer
      Valid values[ 2, 5, 14, 19, 20, 21 ]
      right
      string (ipv4)
      rightID
      OneOf
      string
      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
      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.

      id
      string

      id.

      rightASN
      integer
      Maximum65534
      Minimum64510
      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

      Forbidden

      404

      Region not found


      Was this article helpful?