Skip to main content
POST
Start a server

Authorizations

Authorization
string
header
required

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

Body

application/json
workspace_id
string
required

Workspace to run in.

command
string
required

Command that starts the server and keeps running.

port
integer
required

Port the command listens on, from 1024 to 65535.

exec
string

Setup command to run once before the server starts, such as an install.

name
string

Display name for the server.

timeout
integer

Seconds before the server is shut down. Pass 0 to keep it running.

access
enum<string>

Who can reach the URL. Defaults to workspace members.

Available options:
public,
workspace,
personal

Response

Successful response

The response is of type object.