Langsung ke konten utama
GET
/
instances
/
{instanceId}
/
peers
/
{peerId}
Ambil 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

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"

โ€‹
peerId
string<uuid>
required

Pengenal unik (UUID) untuk peer.

Example:

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

Response

Detail peer yang diminta.

โ€‹
id
string<uuid>

Pengenal unik untuk peer.

Example:

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

โ€‹
type
enum<string>

Tipe peer. client mewakili pengguna individu, sedangkan site mewakili koneksi site-to-site.

Opsi yang tersedia:
client,
site
Example:

"client"

โ€‹
user_id
string<uuid> | null

Pengenal unik untuk pengguna, jika peer bertipe client.

Example:

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

โ€‹
site_id
string<uuid> | null

Pengenal unik untuk situs, jika peer bertipe site.

Example:

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

โ€‹
subnets
string[]

Daftar subnet (dalam notasi CIDR) yang dirutekan oleh peer ini. Hanya berlaku untuk peer site.

โ€‹
route_all
boolean

Jika benar, semua lalu lintas klien akan dirutekan melalui VPN. Hanya berlaku untuk peer client.

Example:

false

โ€‹
protocol
enum<string>

Protokol VPN yang digunakan oleh peer ini.

Opsi yang tersedia:
wireguard,
openvpn
Example:

"wireguard"

โ€‹
connected
boolean

Menunjukkan apakah peer saat ini terhubung.

Example:

false

โ€‹
connected_from
string<ipv4> | null

Alamat IP publik dari peer yang terhubung.

Example:

null

โ€‹
token
string | null

Token berumur pendek untuk peer client guna mengambil file konfigurasi mereka. Bukan untuk penggunaan API langsung.

Example:

"eyJpdiI6..."

โ€‹
token_ttl
integer

Waktu hidup (time-to-live) untuk token dalam detik.

Example:

3600

โ€‹
created_at
string<date-time>

Stempel waktu saat peer dibuat.

Example:

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