Langsung ke konten utama
GET
/
instances
/
{instanceId}
Ambil instans VPN
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "VPN Produksi Utama",
  "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": "Izinkan 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

Masukkan token pembawa Anda dalam format: Bearer {token}

Path Parameters

​
instanceId
string<uuid>
required

Pengenal unik (UUID) untuk instans VPN.

Example:

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

Response

Detail instans VPN yang diminta.

​
id
string<uuid>

Pengenal unik untuk instans VPN.

Example:

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

​
name
string

Nama yang dapat dibaca manusia untuk instans.

Example:

"VPN Produksi Utama"

​
region
string

Wilayah geografis tempat instans diterapkan.

Example:

"sjc"

​
hostname
string

Nama domain yang sepenuhnya memenuhi syarat (FQDN) dari instans VPN.

Example:

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

​
configured
boolean

Menunjukkan apakah penyiapan server awal telah selesai.

Example:

true

​
rsa_ready
boolean

Menunjukkan apakah sertifikat RSA telah dibuat.

Example:

true

​
diffie_hellman_ready
boolean

Menunjukkan apakah parameter Diffie-Hellman telah dibuat.

Example:

true

​
server_ready
boolean

Indikator umum kesiapan server.

Example:

true

​
status
string[]

Array string yang menunjukkan perubahan konfigurasi yang sedang berlangsung. Array kosong berarti konfigurasi stabil.

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

Daftar rute jaringan (dalam notasi CIDR) yang akan di-push ke klien yang terhubung.

​
public_dns
string<ipv4>[]

Daftar server DNS publik yang akan digunakan oleh klien.

​
split_dns
string<ipv4>[]

Daftar server DNS pribadi untuk domain tertentu (split-tunnel DNS).

​
domains
string[]

Daftar nama domain yang harus di-resolve menggunakan server split_dns.

​
dns_custom
object[]

Daftar catatan DNS kustom yang akan dilayani oleh proksi DNS instans.

​
firewall
object[]

Daftar aturan firewall yang diterapkan pada instans.

​
created_at
string<date-time>

Stempel waktu saat instans dibuat.

Example:

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