Create an exec instance

/v1.33

POST

/containers/{id}/exec

Exec

Run a command inside a running container.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.33/containers//exec' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AttachStderr": true,
    "AttachStdin": false,
    "AttachStdout": true,
    "Cmd": [
        "date"
    ],
    "DetachKeys": "ctrl-p,ctrl-q",
    "Env": [
        "FOO=bar",
        "BAZ=quux"
    ],
    "Tty": false
}'

Response Example

201 - Example 1

{
    "Id": "string"
}

Request

Path Params

string

required

ID or name of container

Body Params application/json

AttachStderr

boolean

optional

Attach to stderr of the exec command.

AttachStdin

boolean

optional

Attach to stdin of the exec command.

AttachStdout

boolean

optional

Attach to stdout of the exec command.

Cmd

array[string]

optional

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

DetachKeys

string

optional

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 _.

Env

array[string]

optional

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

Privileged

boolean

optional

Runs the exec process with extended privileges.

Default:

false

Tty

boolean

optional

Allocate a pseudo-TTY.

User

string

optional

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

Examples

Responses

🟢201no error

application/json

Body

Response to an API call that returns just an Id

string

required

The id of the newly created object.

🟠404no such container

🟠409container is paused

🔴500Server error

Modified at 2022-09-10 17:56:06

Wait for a container

Inspect an exec instance