HEhexlet
Exec

Start an exec instance

Changed on

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

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

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

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the request body

    • breaking

      removed the success response with the status

    • info

      api tag Exec added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      request body became required

    • breaking

      the / request property format changed from no format to int32

    • breaking

      removed the success response with the status

    • info

      api tag Exec removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the success response with the status