Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
peers
/
{peerId}
Obter um 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

Insira seu token bearer no formato: Bearer {token}

Path Parameters

​
instanceId
string<uuid>
required

O identificador único (UUID) para a instância de VPN.

Example:

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

​
peerId
string<uuid>
required

O identificador único (UUID) para o peer.

Example:

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

Response

Os detalhes do peer solicitado.

​
id
string<uuid>

O identificador único para o peer.

Example:

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

​
type
enum<string>

O tipo de peer. client representa um usuário individual, enquanto site representa uma conexão site-to-site.

Opções disponíveis:
client,
site
Example:

"client"

​
user_id
string<uuid> | null

O identificador único para o usuário, se o peer for do tipo client.

Example:

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

​
site_id
string<uuid> | null

O identificador único para o site, se o peer for do tipo site.

Example:

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

​
subnets
string[]

Uma lista de sub-redes (em notação CIDR) que este peer roteia. Aplicável apenas para peers do tipo site.

​
route_all
boolean

Se verdadeiro, todo o tráfego do cliente será roteado através da VPN. Aplicável apenas para peers do tipo client.

Example:

false

​
protocol
enum<string>

O protocolo VPN usado por este peer.

Opções disponíveis:
wireguard,
openvpn
Example:

"wireguard"

​
connected
boolean

Indica se o peer está atualmente conectado.

Example:

false

​
connected_from
string<ipv4> | null

O endereço IP público do peer conectado.

Example:

null

​
token
string | null

Um token de curta duração para peers do tipo client recuperarem seus arquivos de configuração. Não para uso direto da API.

Example:

"eyJpdiI6..."

​
token_ttl
integer

O tempo de vida (time-to-live) do token em segundos.

Example:

3600

​
created_at
string<date-time>

O timestamp de quando o peer foi criado.

Example:

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