v1

latestSwagger 2.02026-07-17107130444.8 KB

Exec

Start an exec instance

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

post/exec/{id}/start

Path parameters

idstring required

Exec instance ID

Request body

Detachboolean

Detach from the command.

Ttyboolean

Allocate a pseudo-TTY.

ConsoleSizeinteger[] nullable

Initial console size, as an [height, width] array.

Example request

{
  "Tty": true,
  "ConsoleSize": [
    80,
    64
  ]
}

Response

No error