Skip to main content
POST
Open a VM port
On a public reservation the port is reachable from the internet on the host’s public IP. For the full flow, see Open ports on a VM.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Path Parameters

node_id
string<uuid>
required

The VM's node_id from the reservation's VM list.

vm_id
string<uuid>
required

The VM's id from the reservation's VM list.

Body

application/json
guest_port
integer
required
Required range: 1 <= x <= 65535
public_port
integer

Defaults to guest_port.

protocol
enum<string>
default:tcp
Available options:
tcp,
udp

Response

Port accepted. The body is the new port, opening.

id
string<uuid>
required
virtual_machine_id
string<uuid>
required
node_id
string<uuid>
required
protocol
enum<string>
required
Available options:
tcp,
udp
public_port
integer
required

The port on the host's public IP. Held for this VM while the reservation is private, so it opens again when the reservation switches back to public.

guest_port
integer
required

The port inside the VM that public_port forwards to.

status
enum<string>
required

opening until the host applies the change; open when published on the host's public IP; private while the reservation is private (reach the VM at its private_ip instead); failed with failure set.

Available options:
opening,
open,
private,
failed
created_at
string<date-time>
required
failure
null | object