Saltar al contenido principal
GET
/
instances
/
{instanceId}
/
peers
Listar todos los pares para una instancia
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId}/peers \
  --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

Introduzca su token de portador en el formato: Bearer {token}

Path Parameters

​
instanceId
string<uuid>
required

El identificador único (UUID) para la instancia de VPN.

Example:

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

Query Parameters

​
type
enum<string>

Filtrar los resultados por tipo de par.

Opciones disponibles:
client,
site
Example:

"client"

Response

Una lista de pares.

​
id
string<uuid>

El identificador único para el par.

Example:

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

​
type
enum<string>

El tipo de par. client representa un usuario individual, mientras que site representa una conexión de sitio a sitio.

Opciones disponibles:
client,
site
Example:

"client"

​
user_id
string<uuid> | null

El identificador único para el usuario, si el par es de tipo client.

Example:

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

​
site_id
string<uuid> | null

El identificador único para el sitio, si el par es de tipo site.

Example:

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

​
subnets
string[]

Una lista de subredes (en notación CIDR) que este par enruta. Solo aplicable para pares de tipo site.

​
route_all
boolean

Si es verdadero, todo el tráfico del cliente se enrutará a través de la VPN. Solo aplicable para pares de tipo client.

Example:

false

​
protocol
enum<string>

El protocolo VPN utilizado por este par.

Opciones disponibles:
wireguard,
openvpn
Example:

"wireguard"

​
connected
boolean

Indica si el par está actualmente conectado.

Example:

false

​
connected_from
string<ipv4> | null

La dirección IP pública del par conectado.

Example:

null

​
token
string | null

Un token de corta duración para que los pares de tipo client recuperen sus archivos de configuración. No para uso directo de la API.

Example:

"eyJpdiI6..."

​
token_ttl
integer

El tiempo de vida del token en segundos.

Example:

3600

​
created_at
string<date-time>

La marca de tiempo de cuándo se creó el par.

Example:

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