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

Claim your docs

Docker

GET

Attach to a container via a websocket

/v1.33/containers/{id}/attach/ws

Access Token Required: API Key

Path Parameters

idstringrequired

ID or name of the container

Query Params

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

logsbooleanDefault: false

Return logs

streambooleanDefault: false

Return stream

stdinbooleanDefault: false

Attach to `stdin`

stdoutbooleanDefault: false

Attach to `stdout`

stderrbooleanDefault: false

Attach to `stderr`

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 GET \
2     --url '/v1.33/containers/{id}/attach/ws' \
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}

GET