HEhexlet
Exec

Create an exec instance

Changed on

Run a command inside a running container.

post/containers/{id}/exec

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

ID or name of container

Request body

AttachStdinboolean

Attach to stdin of the exec command.

AttachStdoutboolean

Attach to stdout of the exec command.

AttachStderrboolean

Attach to stderr of the exec command.

ConsoleSizeinteger[] nullable

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

DetachKeysstring

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _.

Ttyboolean

Allocate a pseudo-TTY.

Envstring[]

A list of environment variables in the form ["VAR=value", ...].

Cmdstring[]

Command to run, as a string or array of strings.

Privilegedboolean

Runs the exec process with extended privileges.

Userstring

The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid.

WorkingDirstring

The working directory for the exec process inside the container.

Example request

{
  "AttachStdin": false,
  "AttachStdout": true,
  "AttachStderr": true,
  "DetachKeys": "ctrl-p,ctrl-q",
  "Tty": false,
  "Cmd": [
    "date"
  ],
  "Env": [
    "FOO=bar",
    "BAZ=quux"
  ]
}

Response

no error

Idstring required

The id of the newly created object.

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 non-success response with the status

    • info

      added the success response with the status

  • 31f80d10d31aRevision changes
    • 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

      the request property default value false was removed

    • info

      removed the non-success response with the status

    • 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