Create VPN Profile

Insert new VPN profile.

POST /api/v1/vpn

cURL

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/vpn \
  --header 'Content-Type: application/json' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '
{
  "organization": 123,
  "email": "[e-mail]"
}
'

import requests

url = "https://app.aegister.com/api/v1/vpn"

payload = {
    "organization": 123,
    "email": "[e-mail]"
}
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({organization: 123, email: '[e-mail]'})
};

fetch('https://app.aegister.com/api/v1/vpn', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.aegister.com/api/v1/vpn",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'organization' => 123,
    'email' => '[e-mail]'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Aegister-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aegister.com/api/v1/vpn"

	payload := strings.NewReader("{\n  \"organization\": 123,\n  \"email\": \"[e-mail]\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Aegister-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/vpn")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"organization\": 123,\n  \"email\": \"[e-mail]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/vpn")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"organization\": 123,\n  \"email\": \"[e-mail]\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "error": 0,
  "messages": "<array>",
  "vpn": 123
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

Authorizations

ApiKeyAuthApiKeyQueryParam

X-Aegister-Token · string · header · required

Body

application/jsonmultipart/form-data

organization · number

Unique identifier for the Organization.

Examples:

1

2

3

email · string<email>

Email address of the user to be assigned to the VPN profile.

Example:

"[e-mail]"

Response

201

application/json

error · integer

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

Required range: 0 <= x <= 0

Example:

0

messages · array

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

Example:

[]

vpn · number

Created VPN profile unique id.