Saltar al contenido principal
GET
/
instances
/
{instanceId}
Obtener una instancia de VPN
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "VPN Principal de Producción",
  "region": "sjc",
  "hostname": "my-vpn-gateway.vpn.altostr.at",
  "configured": true,
  "rsa_ready": true,
  "diffie_hellman_ready": true,
  "server_ready": true,
  "status": [
    "peer-created"
  ],
  "pushed_routes": [
    "10.0.0.0/8"
  ],
  "public_dns": [
    "9.9.9.9"
  ],
  "split_dns": [
    "192.168.1.1"
  ],
  "domains": [
    "internal.corp"
  ],
  "dns_custom": [
    {
      "name": "servidorarchivos.interno.corp",
      "type": "A",
      "value": "192.168.1.10"
    }
  ],
  "firewall": [
    {
      "name": "Permitir ICMP",
      "protocol": "icmp",
      "port": "1-65535",
      "source": "0.0.0.0/0",
      "destination": "0.0.0.0/0"
    }
  ],
  "created_at": "2025-10-29T12:30:31Z"
}

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"

Response

Detalles de la instancia de VPN solicitada.

​
id
string<uuid>

El identificador único para la instancia de VPN.

Example:

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

​
name
string

Un nombre legible por humanos para la instancia.

Example:

"VPN Principal de Producción"

​
region
string

La región geográfica donde está desplegada la instancia.

Example:

"sjc"

​
hostname
string

El nombre de dominio completamente calificado (FQDN) de la instancia de VPN.

Example:

"my-vpn-gateway.vpn.altostr.at"

​
configured
boolean

Indica si la configuración inicial del servidor se ha completado.

Example:

true

​
rsa_ready
boolean

Indica si se han generado los certificados RSA.

Example:

true

​
diffie_hellman_ready
boolean

Indica si se han generado los parámetros de Diffie-Hellman.

Example:

true

​
server_ready
boolean

Un indicador general de la disponibilidad del servidor.

Example:

true

​
status
string[]

Un array de cadenas que indica cualquier cambio de configuración en curso. Un array vacío significa que la configuración es estable.

Example:
["peer-created"]
​
pushed_routes
string[]

Una lista de rutas de red (en notación CIDR) que se enviarán a los clientes que se conecten.

​
public_dns
string<ipv4>[]

Una lista de servidores DNS públicos para ser utilizados por los clientes.

​
split_dns
string<ipv4>[]

Una lista de servidores DNS privados para dominios específicos (DNS de túnel dividido).

​
domains
string[]

Una lista de nombres de dominio que deben resolverse utilizando los servidores split_dns.

​
dns_custom
object[]

Una lista de registros DNS personalizados que serán servidos por el proxy DNS de la instancia.

​
firewall
object[]

Una lista de reglas de firewall aplicadas a la instancia.

​
created_at
string<date-time>

La marca de tiempo de cuándo se creó la instancia.

Example:

"2025-10-29T12:30:31Z"