Skip to content

Publish a port

Publish a Computer's TCP service on an assigned public port. Public ports are included in the plan's allowance and use Heaven's shared public address, or a static IPv4 address attached to the pool or account. Publishing requires permission under the organization's external sharing policy and room in the port allowance. The response gives a public address and port that anyone on the internet can reach. The service controls its own authentication.

Parameters

#
computerstringRequired
Computer name or ID.
guest_portstringRequired
TCP port the service listens on inside the Computer, from 1 to 65535 except the reserved desktop port 6080. A pool can take up to 10 new public port numbers per rolling 24-hour window.

Returns

#
dataobjectAlways present
A public port forwarding traffic to a Computer.
Show 7 attributesHide attributes
addressstringAlways present
Public connection address.
computer_idstringAlways present
Computer ID.
guest_portintegerAlways present
Destination port inside the Computer.
namestringAlways present
Computer name.
organizationstring
Computer's organization, when applicable. May be omitted.
portintegerAlways present
Public port to connect to.
published_atstring (date-time)Always present
When the port was published.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.