Skip to main content
GET
/
instances
/
{instanceId}
/
peers
/
{peerId}
Retrieve a peer
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId}/peers/{peerId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "client",
  "user_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "site_id": "c3d5e2a0-88c9-4f7f-9f7b-6a1e2b4c5d6e",
  "subnets": [
    "192.168.100.0/24"
  ],
  "route_all": false,
  "protocol": "wireguard",
  "connected": false,
  "connected_from": null,
  "token": "eyJpdiI6...",
  "token_ttl": 3600,
  "created_at": "2025-10-29T12:45:00Z"
}

Authorizations

โ€‹
Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Path Parameters

โ€‹
instanceId
string<uuid>
required

The unique identifier (UUID) for the VPN instance.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

โ€‹
peerId
string<uuid>
required

The unique identifier (UUID) for the peer.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

The requested peer details.

โ€‹
id
string<uuid>

The unique identifier for the peer.

Example:

"550e8400-e29b-41d4-a716-446655440000"

โ€‹
type
enum<string>

The type of peer. client represents an individual user, while site represents a site-to-site connection.

Available options:
client,
site
Example:

"client"

โ€‹
user_id
string<uuid> | null

The unique identifier for the user, if the peer is of type client.

Example:

"a1b2c3d4-e5f6-7890-1234-567890abcdef"

โ€‹
site_id
string<uuid> | null

The unique identifier for the site, if the peer is of type site.

Example:

"c3d5e2a0-88c9-4f7f-9f7b-6a1e2b4c5d6e"

โ€‹
subnets
string[]

A list of subnets (in CIDR notation) that this peer routes. Only applicable for site peers.

โ€‹
route_all
boolean

If true, all of the client's traffic will be routed through the VPN. Only applicable for client peers.

Example:

false

โ€‹
protocol
enum<string>

The VPN protocol used by this peer.

Available options:
wireguard,
openvpn
Example:

"wireguard"

โ€‹
connected
boolean

Indicates if the peer is currently connected.

Example:

false

โ€‹
connected_from
string<ipv4> | null

The public IP address of the connected peer.

Example:

null

โ€‹
token
string | null

A short-lived token for client peers to retrieve their configuration files. Not for direct API use.

Example:

"eyJpdiI6..."

โ€‹
token_ttl
integer

The time-to-live for the token in seconds.

Example:

3600

โ€‹
created_at
string<date-time>

The timestamp when the peer was created.

Example:

"2025-10-29T12:45:00Z"