Remote supctl

Invoke the remote-supctl operation

Run a remote instance of supctl running in Control Tower.

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

header Parameters
Connection
required
string
Value: "upgrade"
Upgrade
required
string
Value: "websocket"
Sec-WebSocket-Version
required
integer
Value: 13
Sec-WebSocket-Key
required
string <byte>

base64-encoded randomly selected 16-byte nonce value

Sec-WebSocket-Protocol
Array of strings unique

Comma-separated list of websocket protocols in priority order. Valid protocol values are:

  • v1.exec-interactive.supd: protocol uses binary frames
    Websocket frames sent by the server contain chunks of raw merged standard output and standard error streams.
    Websocket frames sent by the client can be of two types: data frames and control frames. Each data frame consists of a single 0x10 byte followed by a chunk of application's standard input stream. Each control frame consists of a single 0x11 byte followed by a json object containing two keys: h and w, denoting the number of lines and columns in the terminal correspondingly. Such control frame should be sent every time the terminal size changes.
Responses
101

Switching Protocols

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

426

Upgrade Required

503

Service Unavailable (strongbox sealed)

get/v1/remote-supctl