Skip to content

Lists the loopback ports the run's own processes listen on, which a browser preview can open; a run not live on this node has none.

GET
/v1/m/sessions/runs/{ref}/preview
curl --request GET \
--url https://example.com/v1/m/sessions/runs/example/preview \
--header 'Authorization: Bearer <token>'

Lists the loopback ports the run’s own processes listen on, which a browser preview can open; a run not live on this node has none.

ref
required
string

Path parameter ref.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

The ports the session’s own processes listen on

Media type application/json
object
ports
required
Array<integer>
Example generated
{
"ports": [
1
]
}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}

The session’s ports cannot be read on this host

Media type application/json
object
Example generated
{}