Skip to main content
POST
/
instances
/
{instance}
/
peers
Create a new peer on an instance
curl --request POST \
  --url https://api.altostrat.io/instances/{instance}/peers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "client",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subnets": [
    "<string>"
  ],
  "route_all": true,
  "protocol": "wireguard"
}'
{
  "id": "<string>",
  "type": "client",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subnets": [
    "<string>"
  ],
  "route_all": true,
  "protocol": "wireguard",
  "connected": true,
  "connected_from": "2023-11-07T05:31:56Z",
  "token": "<string>",
  "token_ttl": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
instance
string<uuid>
required

UUID of the instance

Body

application/json

Peer creation payload

​
customer_id
string<uuid>
required
​
instance_id
string<uuid>
required
​
type
enum<string>
required
Available options:
client,
site
​
protocol
enum<string>
required
Available options:
wireguard,
openvpn
​
site_id
string<uuid> | null
​
user_id
string<uuid> | null
​
subnets
string[]
​
route_all
boolean

Response

Peer created successfully

​
id
string
​
type
enum<string>
Available options:
client,
site
​
user_id
string<uuid> | null
​
site_id
string<uuid> | null
​
subnets
string[]
​
route_all
boolean
​
protocol
enum<string>
Available options:
wireguard,
openvpn
​
connected
boolean
​
connected_from
string<date-time> | null
​
token
string | null
​
token_ttl
integer

TTL in seconds

​
created_at
string<date-time>
⌘I