Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
Obter uma instância de VPN
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "VPN de Produção Principal",
  "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": "fileserver.internal.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

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"

Response

Os detalhes da instância de VPN solicitada.

​
id
string<uuid>

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

Example:

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

​
name
string

Um nome legível por humanos para a instância.

Example:

"VPN de Produção Principal"

​
region
string

A região geográfica onde a instância está implantada.

Example:

"sjc"

​
hostname
string

O nome de domínio totalmente qualificado (FQDN) da instância de VPN.

Example:

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

​
configured
boolean

Indica se a configuração inicial do servidor foi concluída.

Example:

true

​
rsa_ready
boolean

Indica se os certificados RSA foram gerados.

Example:

true

​
diffie_hellman_ready
boolean

Indica se os parâmetros de Diffie-Hellman foram gerados.

Example:

true

​
server_ready
boolean

Um indicador geral da prontidão do servidor.

Example:

true

​
status
string[]

Um array de strings indicando quaisquer alterações de configuração em andamento. Um array vazio significa que a configuração está estável.

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

Uma lista de rotas de rede (em notação CIDR) que serão enviadas para os clientes que se conectarem.

​
public_dns
string<ipv4>[]

Uma lista de servidores DNS públicos a serem usados pelos clientes.

​
split_dns
string<ipv4>[]

Uma lista de servidores DNS privados para domínios específicos (DNS split-tunnel).

​
domains
string[]

Uma lista de nomes de domínio que devem ser resolvidos usando os servidores split_dns.

​
dns_custom
object[]

Uma lista de registros DNS personalizados a serem servidos pelo proxy DNS da instância.

​
firewall
object[]

Uma lista de regras de firewall aplicadas à instância.

​
created_at
string<date-time>

O timestamp de quando a instância foi criada.

Example:

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