Skip to main content
POST
/
api
/
v1
/
workspaces
/
{id}
/
expose-port
Detect or expose a port as a routable app.
curl --request POST \
  --url https://api.rigbox.dev/api/v1/workspaces/{id}/expose-port \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "port": 1,
  "step": "<string>",
  "name": "<string>"
}
'
{
  "command": "<string>",
  "cwd": "<string>",
  "env_vars": [
    "<string>"
  ],
  "is_systemd": true,
  "pid": 1,
  "port": 1,
  "process_name": "<string>",
  "suggested_name": "<string>",
  "systemd_unit": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rigbox.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Workspace ID

Body

application/json
​
port
integer<int32>
required
Required range: x >= 0
​
step
string
required
​
name
string | null

Response

200 - application/json

Port exposed

Detection result for exposing ports - shows what was found before confirmation.

​
command
string
required
​
cwd
string
required
​
env_vars
string[]
required
​
is_systemd
boolean
required
​
pid
integer<int32>
required
Required range: x >= 0
​
port
integer<int32>
required
Required range: x >= 0
​
process_name
string
required
​
suggested_name
string
required
​
step
enum<string>
required
Available options:
detect
​
systemd_unit
string | null