Skip to main content
POST
/
service
/
{tenant_name}
/
wg_tunnel
/
{user_name}
/
{system_name}
Create a new VPN app tunnel
curl --request POST \
  --url https://api.example.com/service/{tenant_name}/wg_tunnel/{user_name}/{system_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "public_key": "<string>",
  "private_key": "<string>",
  "psk": "<string>",
  "tunnel_ip": "<string>",
  "labels": {},
  "description": "<string>"
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "received",
  "extra_details": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Query Parameters

​
username
string
required

Body

application/json
​
name
string | null
​
public_key
string | null
​
private_key
string | null
​
psk
string | null
​
tunnel_ip
string | null
​
labels
Labels · object
​
description
string | null

Response

Successful Response

​
id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
status
enum<string>
required
Available options:
received,
in_progress,
success,
failed,
cancelled
​
extra_details
Extra Details · object