> ## Documentation Index
> Fetch the complete documentation index at: https://namespace.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Expose ports
> Publish HTTP ports of a running Devbox on shareable devbox.so URLs.
Use `devbox.exposedPorts` to publish an HTTP server running on a Devbox at a `devbox.so` URL, and to list and remove the URLs a Devbox exposes.
Exposed port operations start a stopped Devbox automatically.
See [Shareable URLs](/docs/devbox/url) for how `devbox.so` URLs work and who can open them.
## `exposedPorts.create()`
Use `exposedPorts.create()` to expose an HTTP port and get its URL.
Example
```typescript {2-3} theme={null}
const devbox = await client.devboxes.get("sdk-example");
const port = await devbox.exposedPorts.create({ name: "web", number: 3000 });
console.log(port.url);
```
API reference
```typescript theme={null}
exposedPorts.create(input: ExposedPort, options?: OperationOptions): Promise
```
Arguments and options
The port to expose.
The port number. It must be an integer between `1` and `65535`.
A name for the port, which you can use to look it up later. When set, it must not be empty or contain only whitespace.
Supports `signal` and `timeoutMs`. See [Handle errors and timeouts](/docs/reference/typescript-sdk/devbox/errors#operationoptions).
Return value
`exposedPorts.create()` resolves with the [`ExposedPortInfo`](#exposedportinfo) for the new port, including its `url`. It throws a `RangeError` for an invalid port number and a `TypeError` for an empty name, before contacting the Devbox.
***
## `exposedPorts.get()`
Use `exposedPorts.get()` to look up one exposed port by ID, name, or number.
Example
```typescript {2-3} theme={null}
const devbox = await client.devboxes.get("sdk-example");
const port = await devbox.exposedPorts.get({ name: "web" });
console.log(port.url);
```
API reference
```typescript theme={null}
exposedPorts.get(selector: ExposedPortSelector, options?: OperationOptions): Promise
```
Arguments and options
The port to look up. See [`ExposedPortSelector`](#exposedportselector).
Supports `signal` and `timeoutMs`. See [Handle errors and timeouts](/docs/reference/typescript-sdk/devbox/errors#operationoptions).
Return value
`exposedPorts.get()` resolves with the matching [`ExposedPortInfo`](#exposedportinfo). It lists the Devbox's exposed ports and selects the match on the client. It rejects with `ExposedPortNotFoundError` when no port matches.
***
## `exposedPorts.list()`
Use `exposedPorts.list()` to list the HTTP ports a Devbox exposes.
Example
```typescript {2-5} theme={null}
const devbox = await client.devboxes.get("sdk-example");
const ports = await devbox.exposedPorts.list();
for (const port of ports) {
console.log(port.number, port.url);
}
```
API reference
```typescript theme={null}
exposedPorts.list(options?: OperationOptions): Promise
```
Arguments and options
Supports `signal` and `timeoutMs`. See [Handle errors and timeouts](/docs/reference/typescript-sdk/devbox/errors#operationoptions).
Return value
`exposedPorts.list()` resolves with an [`ExposedPortInfo`](#exposedportinfo) for each HTTP port the Devbox agent reports, including ports owned by Namespace. Check `owner` to distinguish them. Port forwards are not included.
***
## `exposedPorts.delete()`
Use `exposedPorts.delete()` to stop exposing a port. The process listening on the port keeps running.
Example
```typescript {2} theme={null}
const devbox = await client.devboxes.get("sdk-example");
await devbox.exposedPorts.delete({ number: 3000 });
```
API reference
```typescript theme={null}
exposedPorts.delete(selector: ExposedPortSelector, options?: OperationOptions): Promise
```
Arguments and options
The port to stop exposing. See [`ExposedPortSelector`](#exposedportselector).
Supports `signal` and `timeoutMs`. See [Handle errors and timeouts](/docs/reference/typescript-sdk/devbox/errors#operationoptions).
Return value
`exposedPorts.delete()` resolves when the port is no longer exposed. It rejects with `ExposedPortNotFoundError` when no port matches the selector.
***
## Exposed port types
### `ExposedPortInfo`
```typescript theme={null}
interface ExposedPortInfo {
id: string;
name?: string;
number: number;
url: string;
owner: "user" | "namespace" | "unknown";
}
```
The port ID.
The port name, when one is set.
The port number.
The `devbox.so` URL that serves the port.
Who manages the port.
### `ExposedPortSelector`
Selects a port by exactly one of `id`, `name`, or `number`. Passing none or more than one throws a `TypeError`.
```typescript theme={null}
type ExposedPortSelector =
| { id: string }
| { name: string }
| { number: number };
```
## Related documentation
Learn how devbox.so URLs work.
Supervise the servers you expose.
Cancel operations and handle SDK failures.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.