Skip to main content
GET
/
instances
/
{instance}
Show details for a single VPN instance
curl --request GET \
  --url https://api.altostrat.io/instances/{instance} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "region": "<string>",
  "hostname": "<string>",
  "configured": true,
  "rsa_ready": true,
  "diffie_hellman_ready": true,
  "server_ready": true,
  "status": [
    "<any>"
  ],
  "pushed_routes": [
    "<string>"
  ],
  "public_dns": [
    "127.0.0.1"
  ],
  "split_dns": [
    "<string>"
  ],
  "domains": [
    "<string>"
  ],
  "dns_custom": [
    {
      "name": "<string>",
      "type": "A",
      "value": "<string>"
    }
  ],
  "firewall": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instance
string<uuid>
required

UUID of the instance

Response

The requested instance resource

id
string
name
string
region
string
hostname
string
configured
boolean
rsa_ready
boolean
diffie_hellman_ready
boolean
server_ready
boolean
status
any[]

Array of pending config statuses (if any)

pushed_routes
string[]
public_dns
string<ipv4>[]
split_dns
string[]
domains
string[]
dns_custom
object[]
firewall
object[]
created_at
string<date-time>
I