> ## Documentation Index > Fetch the complete documentation index at: https://docs.sailresearch.com/llms.txt > Use this file to discover all available pages before exploring further. # List published ports > Returns every port the Sailbox publishes, with the address to reach each one. This works on a paused or sleeping Sailbox and does not wake it. ## OpenAPI ````yaml /sailbox-openapi.json get /sailboxes/{sailbox_id}/listeners openapi: 3.1.0 info: title: Sail Sailbox API version: '2026-07-26' description: >- Create and operate Sailboxes over HTTP. Sailboxes are fast-booting virtual machines that you can pause, resume, checkpoint, and fork. Three things need an SDK or the CLI: running commands and moving files, turning on SSH, and building an image. Once SSH is on you can use `ssh` and `scp` for the first of those. See the [HTTP API guide](/sailboxes-http-api). servers: - url: https://sailbox-api.sailresearch.com/v1 security: - BearerAuth: [] tags: - name: Apps description: Groups that own Sailboxes. One app per workload. - name: Lifecycle description: >- A Sailbox's whole life: create it, watch it, stop and start it, terminate it. - name: Checkpoints description: Save a Sailbox to start from later, and copy a running one. - name: Networking description: >- Publish ports, serve them on hostnames you own, and identify a Sailbox to other Sailboxes. - name: Volumes description: >- Shared storage that outlives any one Sailbox. Alpha: these endpoints can still change. - name: SSH access description: Certificates for connecting to a Sailbox with `ssh`. - name: Usage description: Resource usage and spend. - name: Identity description: Who your API key belongs to. paths: /sailboxes/{sailbox_id}/listeners: get: tags: - Networking summary: List published ports description: >- Returns every port the Sailbox publishes, with the address to reach each one. This works on a paused or sleeping Sailbox and does not wake it. operationId: listSailboxListeners parameters: - $ref: '#/components/parameters/SailboxId' responses: '200': description: The published ports. content: application/json: schema: $ref: '#/components/schemas/ListenerList' example: data: - guest_port: 8000 protocol: http public_url: >- https://sb-9c8f1e2a-3b4d-4f5a-8c7e-1d2f3a4b5c6d-8000.sail.box route_status: LISTENER_ROUTE_STATUS_ACTIVE '400': description: >- The request was rejected. See the error message for the offending field. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: memory_gib for size m must be between 8 and 128 type: invalid_request_error param: null code: null '401': description: The API key is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Invalid API key type: authentication_error param: null code: invalid_api_key '402': description: >- The organization is out of credits. The error carries a `billing_url` pointing at the page where you add them. Retry once you have. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: >- Your API key has been disabled due to insufficient credits. Visit https://app.sailresearch.com/billing to add credits. type: billing_error param: null code: credits_exhausted billing_url: https://app.sailresearch.com/billing '403': description: The API key is not allowed to perform this operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: sailboxes require an organization-scoped API key type: permission_error param: null code: null '404': description: No Sailbox with that id exists in your organization. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: sailbox "sb_9c8f1e2a-3b4d-4f5a-8c7e-1d2f3a4b5c6d" not found type: not_found_error param: null code: null '429': description: >- For its first ten minutes a new organization is capped on how many requests it can have in flight at once, and yours is over that cap. The request never started, so retry it unchanged after the delay in the `Retry-After` header. The limit clears as those requests finish. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: >- Too many concurrent requests. Please retry after some of your organization's in-flight requests complete. type: rate_limit_error param: null code: rate_limited headers: Retry-After: $ref: '#/components/headers/RetryAfter' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: failed to fetch sailbox type: server_error param: null code: null '503': description: >- Sail is momentarily unavailable. Retry after the delay in the `Retry-After` header when one is present, and with backoff otherwise. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Authentication service unavailable type: server_error param: null code: null headers: Retry-After: $ref: '#/components/headers/RetryAfter' components: parameters: SailboxId: name: sailbox_id in: path required: true schema: type: string pattern: >- ^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}$ description: >- Id of the Sailbox, as returned by create. It is `sb_` followed by a UUID. schemas: ListenerList: type: object properties: data: type: array items: $ref: '#/components/schemas/Listener' description: Every published listener. required: - data ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorObject' Listener: type: object properties: guest_port: type: integer description: Port inside the Sailbox that traffic is sent to. protocol: type: string description: >- 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. public_url: type: string description: HTTPS URL for an `http` listener. examples: - https://sb-9c8f1e2a-3b4d-4f5a-8c7e-1d2f3a4b5c6d-8000.sail.box public_host: type: string description: Host to dial for a `tcp` listener. public_port: type: integer description: Port to dial for a `tcp` listener. route_status: type: string description: >- 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. allowlist: type: array items: type: string description: >- Sources allowed to reach the listener: addresses, ranges, and app names. required: - guest_port - protocol - route_status ErrorObject: type: object required: - message - type - param - code properties: message: type: string description: Human-readable description of what went wrong. type: type: string description: >- Error category: `invalid_request_error`, `authentication_error`, `permission_error`, `billing_error`, `not_found_error`, `conflict_error`, `rate_limit_error`, or `server_error`. param: oneOf: - type: string - type: 'null' description: >- The request field the error refers to, when the error is about one field. code: oneOf: - type: string - type: integer - type: 'null' description: Stable short code for the error, when one applies. billing_url: type: string format: uri description: Page where you add credits. Sent with a 402. additionalProperties: true headers: RetryAfter: description: >- How many seconds to wait before retrying. On a 429 it also means the request never started, so the retry can reuse the same `Idempotency-Key`. schema: type: integer minimum: 0 securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key ````