Skip to main content
GET
/
api
/
v1
/
vpn
cURL
curl --request GET \
  --url https://app.aegister.com/api/v1/vpn \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": 123,
      "organization": {
        "id": 123,
        "name": "<string>",
        "logo": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com"
    }
  ]
}

Authorizations

​
X-Aegister-Token
string
header
required

Query Parameters

​
date
string

Filter VPN profiles by date of creation.

​
email
string

Filter by VPN profile by user email. This filter is case insensitive.

​
include_cert
boolean

Include Certificate in the VPN response object

​
limit
number
default:50

Max number of reponse items.

​
offset
number
default:0

Offset response items.

​
only_mine
boolean

Return only VPN profiles assigned to the user

​
order
string
default:-id

Order results by item field

Response

200 - application/json
​
error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0
​
messages
array

If error is 1, contains zero or more details on the error.

​
total
number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0
​
data
object[]