HEhexlet
Container

Attach to a container via a websocket

Changed on
get/containers/{id}/attach/ws

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 the container

Query parameters

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

logsboolean

Return logs

streamboolean

Return stream

stdinboolean

Attach to stdin

stdoutboolean

Attach to stdout

stderrboolean

Attach to stderr

Response

no error, no upgrade header found

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the success response with the status

    • info

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

    • info

      added the success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      for the query request parameter logs, default value false was removed

    • breaking

      for the query request parameter stderr, default value false was removed

    • breaking

      for the query request parameter stdin, default value false was removed

    • breaking

      for the query request parameter stdout, default value false was removed

    • breaking

      for the query request parameter stream, default value false was removed

    • breaking

      removed the success response with the status

    • info

      api tag Container 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

      removed the non-success response with the status

    • info

      added the success response with the status