terminalSessions.open

POST

/terminal-sessions

curl --request POST \
  --url https://example.com/api/terminal-sessions \
  --header 'Content-Type: application/json' \
  --data '{ "scope": { "kind": "server", "serverId": "example" }, "relativeDirectory": "example", "initialRows": 24, "initialCols": 80 }'

Opens a controlled terminal session for server or resource troubleshooting. Public docs: /docs/servers/operations/proxy-and-terminal/#server-terminal-session

Request Body ^required

Media type application/json

object

scope

required

One of:

object

object

kind

required

string

Allowed value: server

serverId

required

string

>= 1 characters

object

object

kind

required

string

Allowed value: resource

resourceId

required

string

>= 1 characters

deploymentId

string

>= 1 characters

relativeDirectory

string

>= 1 characters <= 512 characters

initialRows

integer

default: 24 >= 10 <= 120

initialCols

integer

default: 80 >= 20 <= 320

Responses

201

OK

Media type application/json

object

sessionId

required

string

scope

required

string

Allowed values: server resource

serverId

required

string

resourceId

string

deploymentId

string

transport

required

object

kind

required

string

Allowed value: websocket

path

required

string

providerKey

required

string

workingDirectory

string

createdAt

required

string

Example

{
  "scope": "server",
  "transport": {
    "kind": "websocket"
  }
}