Retrieve a published port
Returns one published port and the address to reach it.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Id of the Sailbox, as returned by create. It is sb_ followed by a UUID.
^sb_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Port inside the Sailbox that the listener sends traffic to.
1 <= x <= 65535Response
The published port.
Port inside the Sailbox that traffic is sent to.
Protocol the listener serves. Values in use today are http and tcp. New values can appear over time, so treat this as an open set.
Whether the Sailbox behind this listener is up. LISTENER_ROUTE_STATUS_ACTIVE means it is running and traffic is being routed to it. LISTENER_ROUTE_STATUS_PENDING means it is still starting. LISTENER_ROUTE_STATUS_UNAVAILABLE means the address is held for the Sailbox but nothing is routed there, which is what you see any time it is not running, such as while it is paused or sleeping. This tracks the Sailbox, not the process inside it, so an active route with nothing listening on the port still fails to answer. New values can appear over time, so treat this as an open set.
HTTPS URL for an http listener.
"https://sb-9c8f1e2a-3b4d-4f5a-8c7e-1d2f3a4b5c6d-8000.sail.box"
Host to dial for a tcp listener.
Port to dial for a tcp listener.
Sources allowed to reach the listener: addresses, ranges, and app names.