The workspace

Ports

What is listening inside the sandbox, and forwarding one out

On this page(3 sections)

The ports something is answering on, and giving one an address on the outside or taking that away.

GET/portsWhat is listening inside the sandbox

Every port something is answering on, and whether each one is reachable from outside.

Nothing. Call it as it is.

Field	Type
`ports`Everything listening inside the sandbox right…	object[]
`port`The port number	number
`host`Which loopback address it actually answers…	"127.0.0.1" \| "::1"
`forwardable`Whether it can be exposed at…	boolean
`kind`Whether somebody's own work put it…	"workspace" \| "system"
`title`What a person would call it	string
`purpose`One sentence about what it is…	string
`origin`Who put it there, which is…	"terminal" \| "agent" \| "panel" \| "extension" … (7)
`pid`The process holding it	number
`command`The command behind it, as it…	string
`cwd`Where it is running from, which…	string
`session`The terminal it came from, to…	string
`forwarded`Whether it is currently reachable from…	boolean
`previewUrl`Where to open it	string

Try itanswered in this tab

curl

curl "$SANDBOX/ports" \
  -H "x-intentic-control: $INTENTIC_TOKEN"

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.ports.list();

POST/ports/forwardMake a port reachable

Gives one port an address on the outside. Asking twice is harmless: the second call hands back the address the first one made.

Field	Type	Where
`port`requiredWhich port	integer	body

Field	Type
`previewUrl`Where it can now be reached	string

Try itanswered in this tab

curl

curl -X POST "$SANDBOX/ports/forward" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"port":5173}'

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.ports.forward({
  "port": 5173
});

POST/ports/unforwardStop exposing a port

Frees the slot at once. The address keeps resolving; it simply stops leading anywhere.

Field	Type	Where
`port`requiredWhich port	integer	body

Field	Type
`ok`Always true	true

Try itanswered in this tab

curl

curl -X POST "$SANDBOX/ports/unforward" \
  -H "x-intentic-control: $INTENTIC_TOKEN" \
  -H "content-type: application/json" \
  -d '{"port":5173}'

TypeScript

import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.ports.unforward({
  "port": 5173
});