Skip to content

Close a port

Close a published TCP port to new connections. Existing connections continue until they end or the service stops. For up to 30 days, adding the same Computer port can reclaim its old public port number.

Parameters

#
computerstringRequired
Computer name or ID.
portstringRequired
Assigned public port to close. The Computer's TCP port can also identify it. An exact public port match takes precedence.

Returns

#
dataobjectAlways present
The public port removed by this request.
Show 1 attributeHide attributes
removedobjectAlways present
Port's previous address and guest destination.
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

#
  • API key permission: port remove.