Home
API reference
Platform API
Platform API
VPNs
Get org VPNs

Get org VPNs

get/v1/organizations/{organizationId}/vpns
Page View

VPN endpoints allow you to review and manage configured VPNs within your Redox organization.

VPNs can only be configured and managed by a Redoxer. Only users assigned to an organization owner role can view VPN metadata. Learn about roles.

Get org VPNs

Retrieve a list of VPNs associated with the specified organization.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/vpns' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • organizationId
    required, string

    Identifies the Redox organization that you're operating in or on behalf of.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "vpns": [
7
      {
8
        "name": "redox-vpn-1",
9
        "id": "d63b9307-a759-4e08-9b2a-d172f3ddd479",
10
        "redoxReceivingIp": "10.255.1.1/32",
11
        "custEncDomains": [
12
          "10.255.0.1/32"
13
        ],
14
        "vhost": 7,
15
        "ports": [
16
          {
17
            "number": 9901,
18
            "status": "reserved"
19
          }
20
        ]
21
      }
22
    ]
23
  }
24
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Contains the payload with details about the requested VPN(s).

    • vpns
      Array of object

      Contains an array of VPN metadata objects.

      • name
        string

        Displays the human-readable name of the VPN.

      • id
        string

        Displays the unique identifier (i.e., client ID) of the VPN.

      • redoxReceivingIp
        string

        Contains the IP address that's used when sending data to Redox through the specified VPN.

      • custEncDomains
        Array of string

        Displays the encryption domain(s) (CIDR blocks) that are used to send data through this VPN.

      • vhost
        number

        Displays the assigned virtual host number on the Redox side of the VPN.

      • ports
        Array of or

        Contains details about an assigned or reserved port.

          Contains details about a reserved port for a given VPN.

        • number
          number

          Displays the reserved port number.

        • status
          string

          Displays the reserved status of the port.

          Value: reserved