Skip to main content
GET
/
instances
/
{instance}
/
peers
List all peers under an instance
curl --request GET \
  --url https://api.altostrat.io/instances/{instance}/peers \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

Query Parameters

​
type
enum<string>

Optional filter for peer type

Available options:
client,
site

Response

Array of peers

​
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