Skip to main content
POST
Create a VPN instance

Authorizations

Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Body

application/json
name
string
required

A human-readable name for the new instance.

Required string length: 3 - 20
Example:

"Primary Production VPN"

hostname
string
required

A unique hostname for the instance. This will be part of the FQDN. Must be a valid hostname segment (e.g., 'my-vpn-gateway').

Required string length: 3 - 20
Pattern: ^[a-zA-Z0-9-]+$
Example:

"prod-vpn-sjc"

region
string
required

The identifier for the geographical region to deploy the instance. See the /servers/regions endpoint for available options.

Example:

"sjc"

Response

The VPN instance was created successfully.

id
string<uuid>

The unique identifier for the VPN instance.

Example:

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

name
string

A human-readable name for the instance.

Example:

"Primary Production VPN"

region
string

The geographical region where the instance is deployed.

Example:

"sjc"

hostname
string

The fully qualified domain name (FQDN) of the VPN instance.

Example:

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

configured
boolean

Indicates if the initial server setup has completed.

Example:

true

rsa_ready
boolean

Indicates if the RSA certificates have been generated.

Example:

true

diffie_hellman_ready
boolean

Indicates if the Diffie-Hellman parameters have been generated.

Example:

true

server_ready
boolean

A general indicator of the server's readiness.

Example:

true

status
string[]

An array of strings indicating any ongoing configuration changes. An empty array means the configuration is stable.

Example:
pushed_routes
string[]

A list of network routes (in CIDR notation) that will be pushed to connecting clients.

public_dns
string<ipv4>[]

A list of public DNS servers to be used by clients.

split_dns
string<ipv4>[]

A list of private DNS servers for specific domains (split-tunnel DNS).

domains
string[]

A list of domain names that should be resolved using the split_dns servers.

dns_custom
object[]

A list of custom DNS records to be served by the instance's DNS proxy.

firewall
object[]

A list of firewall rules applied to the instance.

created_at
string<date-time>

The timestamp when the instance was created.

Example:

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