Start an exec instance Run in API Explorer

POST /exec/{id}/start

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.

Path parameters

  • id string Required

    Exec instance ID

application/json

Body

  • Detach boolean

    Detach from the command.

  • Tty boolean

    Allocate a pseudo-TTY.

  • ConsoleSize array[integer]

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

    At least 2 but not more than 2 elements. Minimum value of each is 0.

Responses

POST /exec/{id}/start 
curl \
 --request POST 'http://api.example.com/v1.44/exec/{id}/start' \
 --header "Content-Type: application/json" \
 --data '{"Tty":true,"Detach":false,"ConsoleSize":[80,64]}'
Request examples 
{
  "Tty": true,
  "Detach": false,
  "ConsoleSize": [
    80,
    64
  ]
}
Response examples (404) 
{
  "message": "Something went wrong."
}
Response examples (409) 
{
  "message": "Something went wrong."
}