Vai al contenuto principale
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": "[email protected]"
    }
  ]
}

Autorizzazioni

X-Aegister-Token
string
header
obbligatorio

Parametri della query

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
predefinito:50

Max number of reponse items.

offset
number
predefinito:0

Offset response items.

only_mine
boolean

Return only VPN profiles assigned to the user

order
string
predefinito:-id

Order results by item field

Risposta

200 - application/json
error
integer

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

Intervallo richiesto: 0 <= x <= 0
Esempio:

0

messages
array

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

Esempio:
[]
total
number

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

Intervallo richiesto: x >= 0
Esempi:

20

30

40

data
object[]