Own Docker? Customize your docs with AI search, analytics, and more.

POST

Create an exec instance

/v1.33/containers/{id}/exec

Run a command inside a running container.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of container

Body Params

Cmdarray

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

Envarray

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

Ttyboolean

Allocate a pseudo-TTY.

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

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

Privilegedboolean

Runs the exec process with extended privileges.

AttachStdinboolean

Attach to `stdin` of the exec command.

AttachStderrboolean

Attach to `stderr` of the exec command.

AttachStdoutboolean

Attach to `stdout` of the exec command.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/containers/{id}/exec' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an exec instance

/v1.33/containers/{id}/exec

Run a command inside a running container.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of container

Body Params

Cmdarray

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

Envarray

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

Ttyboolean

Allocate a pseudo-TTY.

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

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

Privilegedboolean

Runs the exec process with extended privileges.

AttachStdinboolean

Attach to `stdin` of the exec command.

AttachStderrboolean

Attach to `stderr` of the exec command.

AttachStdoutboolean

Attach to `stdout` of the exec command.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/containers/{id}/exec' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an exec instance

/v1.33/containers/{id}/exec

Run a command inside a running container.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of container

Body Params

Cmdarray

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

Envarray

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

Ttyboolean

Allocate a pseudo-TTY.

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

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

Privilegedboolean

Runs the exec process with extended privileges.

AttachStdinboolean

Attach to `stdin` of the exec command.

AttachStderrboolean

Attach to `stderr` of the exec command.

AttachStdoutboolean

Attach to `stdout` of the exec command.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/containers/{id}/exec' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Create an exec instance

/v1.33/containers/{id}/exec

Run a command inside a running container.

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of container

Body Params

Cmdarray

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

Envarray

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

Ttyboolean

Allocate a pseudo-TTY.

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

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

Privilegedboolean

Runs the exec process with extended privileges.

AttachStdinboolean

Attach to `stdin` of the exec command.

AttachStderrboolean

Attach to `stderr` of the exec command.

AttachStdoutboolean

Attach to `stdout` of the exec command.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url '/v1.33/containers/{id}/exec' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}