Skip to content

List public ports

List published TCP ports and the remaining allowance, including how many new ports a pool can add in a 24-hour window. Name a Computer to see its public endpoints and recently removed ports it can reclaim. Without a Computer or organization, the view covers your accounts subject to your credential's scope.

Parameters

#
computerstring
Computer name or ID.
organizationstring
Organization name or ID. Omit to read across your accounts within your credential's scope. Supply either an organization or a Computer.

Returns

#
dataobjectAlways present
Published ports and pool allowances.
Show 3 attributesHide attributes
keptobject[]
Recently released ports, included for Computer-specific reads. Adding the guest port again reclaims its public port. May be omitted.
Show 1 attributeHide attributes
itemsobject
A recently released public port retained for this Computer for 30 days.
Show 4 attributesHide attributes
addressstringAlways present
Address it would be published on now.
guest_portintegerAlways present
Guest port to add again to reclaim this public port.
portintegerAlways present
Retained public port number.
released_atstring (date-time)Always present
When the port was released.
poolsobject[] | nullAlways present
Port availability and usage for each selected pool.
Show 1 attributeHide attributes
itemsobject
A pool's public-port usage and availability.
Show 11 attributesHide attributes
allowedintegerAlways present
Applicable public-port allowance.
heldintegerAlways present
Public ports held by this pool's Computers.
idstringAlways present
Pool ID.
namestringAlways present
Pool name.
new_leftintegerAlways present
New ports available within the rolling 24-hour limit. Reclaimed ports are excluded.
new_next_atstring (date-time)
When the new-port allowance next increases. May be omitted.
offeredbooleanAlways present
Whether the pool has an address on which ports can be published.
organizationstring
Owning organization. May be omitted.
reasonstring
Why publishing is unavailable. May be omitted.
sharedboolean
Whether pools in the same account and placement share this allowance. May be omitted.
shared_heldinteger
Ports held across that shared allowance. May be omitted.
portsobject[] | nullAlways present
Currently published ports.
Show 1 attributeHide attributes
itemsobject
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.
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 view.