Skip to main content

Obtaining VPN (for Legacy Apps) Resources Using API

This article provides information on obtaining VPN (for Legacy Apps) resources using APIs. All APIs are rate limited. To learn more, see ZPA API Rate Limits and VPN (for Legacy Apps).

Getting Details of All Users Connected to VPN Service Edges

To get details of all users that are connected to VPN Service Edges:

  1. Send a GET request to the following endpoint: /mgmtconfig/v1/admin/customers/{customerId}/vpnConnectedUsers.
  2. Provide the customerId, the ZPA tenant ID of the customer, in the request endpoint. For example: /mgmtconfig/v1/admin/customers/73229488749543424/vpnConnectedUsers.

Example Response​

{
  "totalPages": "1",
  "currentCount": "1",
  "totalCount": "1",
  "list": [
    {
      "id": "73229488749551415",
      "creationTime": "1756977137",
      "modifiedBy": "72057594038820580",
      "deviceState": "1",
      "clientIPAddress": "192.0.2.0",
      "vpnServiceEdgeId": "73229488749551620",
      "commonName": "dec1bb9059eb7f3392ad3630820f881939d6b3dd4b77795fddc@vishnu1.com",
      "UserName": "exampleUser2@sample.com",
      "vpnServiceEdgeName": "Sample VPN Service Edge Name"
    }
  ]
}

A successful response returns code 200. To learn more, see ZPA API Codes.