XPxpipe

Start shell connection

Starts a new shell session for a connection. If an existing shell session is already running for that connection, this operation will do nothing.

Note that there are a variety of possible errors that can occur here when establishing the shell connection. These errors will be returned with the HTTP return code 500.

post/shell/start

Request

  • Base URL
    http://localhost:21721
  • Auth
    HTTP bearer

Request body

storestring required

The store uuid

Response

The operation was successful. The shell session was started.

shellDialectinteger required

The shell dialect

osTypestring required

The general type of operating system

osNamestring required

The display name of the operating system

ttyStatestring

Whether a tty/pty has been allocated for the connection. If allocated, input and output will be unreliable. It is not recommended to use a shell connection then.

tempstring required

The location of the temporary directory

Changes

No recorded changes to this operation across all 1 revision of this API.