flowground für Geschäftskunden

Technische Spezifikationen

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

SystemPing

This is a dummy endpoint you can use to test if the server is accessible.

OnInit
./lib/actions/SystemPing.js
OnStartup
-
OnClose
-

Attributes

-

SystemAuth

Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.

OnInit
./lib/actions/SystemAuth.js
OnStartup
-
OnClose
-

Attributes

-

ImageBuild

Build an image from a tar archive with a `Dockerfile` in it. The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/). The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output. The build is canceled if the client drops the connection by quitting or being killed.

OnInit
./lib/actions/ImageBuild.js
OnStartup
-
OnClose
-

Attributes

-

BuildPrune

OnInit
./lib/actions/BuildPrune.js
OnStartup
-
OnClose
-

Attributes

-

ImageCommit

OnInit
./lib/actions/ImageCommit.js
OnStartup
-
OnClose
-

Attributes

-

ConfigList

OnInit
./lib/actions/ConfigList.js
OnStartup
-
OnClose
-

Attributes

-

ConfigCreate

OnInit
./lib/actions/ConfigCreate.js
OnStartup
-
OnClose
-

Attributes

-

ConfigDelete

OnInit
./lib/actions/ConfigDelete.js
OnStartup
-
OnClose
-

Attributes

-

ConfigInspect

OnInit
./lib/actions/ConfigInspect.js
OnStartup
-
OnClose
-

Attributes

-

ConfigUpdate

OnInit
./lib/actions/ConfigUpdate.js
OnStartup
-
OnClose
-

Attributes

-

ContainerCreate

OnInit
./lib/actions/ContainerCreate.js
OnStartup
-
OnClose
-

Attributes

-

ContainerList

Returns a list of containers. For details on the format, see [the inspect endpoint](#operation/ContainerInspect). Note that it uses a different, smaller representation of a container than inspecting a single container. For example, the list of linked containers is not propagated .

OnInit
./lib/actions/ContainerList.js
OnStartup
-
OnClose
-

Attributes

-

ContainerPrune

OnInit
./lib/actions/ContainerPrune.js
OnStartup
-
OnClose
-

Attributes

-

ContainerDelete

OnInit
./lib/actions/ContainerDelete.js
OnStartup
-
OnClose
-

Attributes

-

ContainerArchive

Get a tar archive of a resource in the filesystem of container id.

OnInit
./lib/actions/ContainerArchive.js
OnStartup
-
OnClose
-

Attributes

-

ContainerArchiveInfo

A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path.

OnInit
./lib/actions/ContainerArchiveInfo.js
OnStartup
-
OnClose
-

Attributes

-

PutContainerArchive

Upload a tar archive to be extracted to a path in the filesystem of container id.

OnInit
./lib/actions/PutContainerArchive.js
OnStartup
-
OnClose
-

Attributes

-

ContainerAttach

Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached. Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything. See [the documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details. ### Hijacking This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket. This is the response from the daemon for an attach request: ``` HTTP/1.1 200 OK Content-Type: application/vnd.docker.raw-stream [STREAM] ``` After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server. To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers. For example, the client sends this request to upgrade the connection: ``` POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1 Upgrade: tcp Connection: Upgrade ``` The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream: ``` HTTP/1.1 101 UPGRADED Content-Type: application/vnd.docker.raw-stream Connection: Upgrade Upgrade: tcp [STREAM] ``` ### Stream format When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate), the stream over the hijacked connected is multiplexed to separate out `stdout` and `stderr`. The stream consists of a series of frames, each containing a header and a payload. The header contains the information which the stream writes (`stdout` or `stderr`). It also contains the size of the associated frame encoded in the last four bytes (`uint32`). It is encoded on the first eight bytes like this: ```go header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4} ``` `STREAM_TYPE` can be: - 0: `stdin` (is written on `stdout`) - 1: `stdout` - 2: `stderr` `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian. Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`. The simplest way to implement this protocol is the following: 1. Read 8 bytes. 2. Choose `stdout` or `stderr` depending on the first byte. 3. Extract the frame size from the last four bytes. 4. Read the extracted size and output it on the correct output. 5. Goto 1. ### Stream format when using a TTY When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate), the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's `stdin`.

OnInit
./lib/actions/ContainerAttach.js
OnStartup
-
OnClose
-

Attributes

-

ContainerAttachWebsocket

OnInit
./lib/actions/ContainerAttachWebsocket.js
OnStartup
-
OnClose
-

Attributes

-

ContainerChanges

Returns which files in a container's filesystem have been added, deleted, or modified. The `Kind` of modification can be one of: - `0`: Modified - `1`: Added - `2`: Deleted

OnInit
./lib/actions/ContainerChanges.js
OnStartup
-
OnClose
-

Attributes

-

ContainerExec

Run a command inside a running container.

OnInit
./lib/actions/ContainerExec.js
OnStartup
-
OnClose
-

Attributes

-

ContainerExport

Export the contents of a container as a tarball.

OnInit
./lib/actions/ContainerExport.js
OnStartup
-
OnClose
-

Attributes

-

ContainerInspect

Return low-level information about a container.

OnInit
./lib/actions/ContainerInspect.js
OnStartup
-
OnClose
-

Attributes

-

ContainerKill

Send a POSIX signal to a container, defaulting to killing to the container.

OnInit
./lib/actions/ContainerKill.js
OnStartup
-
OnClose
-

Attributes

-

ContainerLogs

Get `stdout` and `stderr` logs from a container. Note: This endpoint works only for containers with the `json-file` or `journald` logging driver.

OnInit
./lib/actions/ContainerLogs.js
OnStartup
-
OnClose
-

Attributes

-

ContainerPause

Use the cgroups freezer to suspend all processes in a container. Traditionally, when suspending a process the `SIGSTOP` signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed.

OnInit
./lib/actions/ContainerPause.js
OnStartup
-
OnClose
-

Attributes

-

ContainerRename

OnInit
./lib/actions/ContainerRename.js
OnStartup
-
OnClose
-

Attributes

-

ContainerResize

Resize the TTY for a container. You must restart the container for the resize to take effect.

OnInit
./lib/actions/ContainerResize.js
OnStartup
-
OnClose
-

Attributes

-

ContainerRestart

OnInit
./lib/actions/ContainerRestart.js
OnStartup
-
OnClose
-

Attributes

-

ContainerStart

OnInit
./lib/actions/ContainerStart.js
OnStartup
-
OnClose
-

Attributes

-

ContainerStats

This endpoint returns a live stream of a container's resource usage statistics. The `precpu_stats` is the CPU statistic of last read, which is used for calculating the CPU usage percentage. It is not the same as the `cpu_stats` field. If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is nil then for compatibility with older daemons the length of the corresponding `cpu_usage.percpu_usage` array should be used.

OnInit
./lib/actions/ContainerStats.js
OnStartup
-
OnClose
-

Attributes

-

ContainerStop

OnInit
./lib/actions/ContainerStop.js
OnStartup
-
OnClose
-

Attributes

-

ContainerTop

On Unix systems, this is done by running the `ps` command. This endpoint is not supported on Windows.

OnInit
./lib/actions/ContainerTop.js
OnStartup
-
OnClose
-

Attributes

-

ContainerUnpause

Resume a container which has been paused.

OnInit
./lib/actions/ContainerUnpause.js
OnStartup
-
OnClose
-

Attributes

-

ContainerUpdate

Change various configuration options of a container without having to recreate it.

OnInit
./lib/actions/ContainerUpdate.js
OnStartup
-
OnClose
-

Attributes

-

ContainerWait

Block until a container stops, then returns the exit code.

OnInit
./lib/actions/ContainerWait.js
OnStartup
-
OnClose
-

Attributes

-

DistributionInspect

Return image digest and platform information by contacting the registry.

OnInit
./lib/actions/DistributionInspect.js
OnStartup
-
OnClose
-

Attributes

-

SystemEvents

Stream real-time events from the server. Various objects within Docker report events when something happens to them. Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, and `update` Images report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, and `untag` Volumes report these events: `create`, `mount`, `unmount`, and `destroy` Networks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, and `remove` The Docker daemon reports these events: `reload` Services report these events: `create`, `update`, and `remove` Nodes report these events: `create`, `update`, and `remove` Secrets report these events: `create`, `update`, and `remove` Configs report these events: `create`, `update`, and `remove`

OnInit
./lib/actions/SystemEvents.js
OnStartup
-
OnClose
-

Attributes

-

ExecInspect

Return low-level information about an exec instance.

OnInit
./lib/actions/ExecInspect.js
OnStartup
-
OnClose
-

Attributes

-

ExecResize

Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance.

OnInit
./lib/actions/ExecResize.js
OnStartup
-
OnClose
-

Attributes

-

ExecStart

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

OnInit
./lib/actions/ExecStart.js
OnStartup
-
OnClose
-

Attributes

-

ImageCreate

Create an image by either pulling it from a registry or importing it.

OnInit
./lib/actions/ImageCreate.js
OnStartup
-
OnClose
-

Attributes

-

ImageGetAll

Get a tarball containing all images and metadata for several image repositories. For each value of the `names` parameter: if it is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID. For details on the format, see [the export image endpoint](#operation/ImageGet).

OnInit
./lib/actions/ImageGetAll.js
OnStartup
-
OnClose
-

Attributes

-

ImageList

Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

OnInit
./lib/actions/ImageList.js
OnStartup
-
OnClose
-

Attributes

-

ImageLoad

Load a set of images and tags into a repository. For details on the format, see [the export image endpoint](#operation/ImageGet).

OnInit
./lib/actions/ImageLoad.js
OnStartup
-
OnClose
-

Attributes

-

ImagePrune

OnInit
./lib/actions/ImagePrune.js
OnStartup
-
OnClose
-

Attributes

-

ImageSearch

Search for an image on Docker Hub.

OnInit
./lib/actions/ImageSearch.js
OnStartup
-
OnClose
-

Attributes

-

ImageDelete

Remove an image, along with any untagged parent images that were referenced by that image. Images can't be removed if they have descendant images, are being used by a running container or are being used by a build.

OnInit
./lib/actions/ImageDelete.js
OnStartup
-
OnClose
-

Attributes

-

ImageGet

Get a tarball containing all images and metadata for a repository. If `name` is a specific name and tag (e.g. `ubuntu:latest`), then only that image (and its parents) are returned. If `name` is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the `repositories` file in the tarball, as there were no image names referenced. ### Image tarball format An image tarball contains one directory per image layer (named using its long ID), each containing these files: - `VERSION`: currently `1.0` - the file format version - `json`: detailed layer information, similar to `docker inspect layer_id` - `layer.tar`: A tarfile containing the filesystem changes in this layer The `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions. If the tarball defines a repository, the tarball should also include a `repositories` file at the root that contains a list of repository and tag names mapped to layer IDs. ```json { "hello-world": { "latest": "565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1" } } ```

OnInit
./lib/actions/ImageGet.js
OnStartup
-
OnClose
-

Attributes

-

ImageHistory

Return parent layers of an image.

OnInit
./lib/actions/ImageHistory.js
OnStartup
-
OnClose
-

Attributes

-

ImageInspect

Return low-level information about an image.

OnInit
./lib/actions/ImageInspect.js
OnStartup
-
OnClose
-

Attributes

-

ImagePush

Push an image to a registry. If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, `registry.example.com/myimage:latest`. The push is cancelled if the HTTP connection is closed.

OnInit
./lib/actions/ImagePush.js
OnStartup
-
OnClose
-

Attributes

-

ImageTag

Tag an image so that it becomes part of a repository.

OnInit
./lib/actions/ImageTag.js
OnStartup
-
OnClose
-

Attributes

-

SystemInfo

OnInit
./lib/actions/SystemInfo.js
OnStartup
-
OnClose
-

Attributes

-

NetworkList

Returns a list of networks. For details on the format, see [the network inspect endpoint](#operation/NetworkInspect). Note that it uses a different, smaller representation of a network than inspecting a single network. For example, the list of containers attached to the network is not propagated in API versions 1.28 and up.

OnInit
./lib/actions/NetworkList.js
OnStartup
-
OnClose
-

Attributes

-

NetworkCreate

OnInit
./lib/actions/NetworkCreate.js
OnStartup
-
OnClose
-

Attributes

-

NetworkPrune

OnInit
./lib/actions/NetworkPrune.js
OnStartup
-
OnClose
-

Attributes

-

NetworkDelete

OnInit
./lib/actions/NetworkDelete.js
OnStartup
-
OnClose
-

Attributes

-

NetworkInspect

OnInit
./lib/actions/NetworkInspect.js
OnStartup
-
OnClose
-

Attributes

-

NetworkConnect

OnInit
./lib/actions/NetworkConnect.js
OnStartup
-
OnClose
-

Attributes

-

NetworkDisconnect

OnInit
./lib/actions/NetworkDisconnect.js
OnStartup
-
OnClose
-

Attributes

-

NodeList

OnInit
./lib/actions/NodeList.js
OnStartup
-
OnClose
-

Attributes

-

NodeDelete

OnInit
./lib/actions/NodeDelete.js
OnStartup
-
OnClose
-

Attributes

-

NodeInspect

OnInit
./lib/actions/NodeInspect.js
OnStartup
-
OnClose
-

Attributes

-

NodeUpdate

OnInit
./lib/actions/NodeUpdate.js
OnStartup
-
OnClose
-

Attributes

-

PluginList

Returns information about installed plugins.

OnInit
./lib/actions/PluginList.js
OnStartup
-
OnClose
-

Attributes

-

PluginCreate

OnInit
./lib/actions/PluginCreate.js
OnStartup
-
OnClose
-

Attributes

-

GetPluginPrivileges

OnInit
./lib/actions/GetPluginPrivileges.js
OnStartup
-
OnClose
-

Attributes

-

PluginPull

Pulls and installs a plugin. After the plugin is installed, it can be enabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).

OnInit
./lib/actions/PluginPull.js
OnStartup
-
OnClose
-

Attributes

-

PluginDelete

OnInit
./lib/actions/PluginDelete.js
OnStartup
-
OnClose
-

Attributes

-

PluginDisable

OnInit
./lib/actions/PluginDisable.js
OnStartup
-
OnClose
-

Attributes

-

PluginEnable

OnInit
./lib/actions/PluginEnable.js
OnStartup
-
OnClose
-

Attributes

-

PluginInspect

OnInit
./lib/actions/PluginInspect.js
OnStartup
-
OnClose
-

Attributes

-

PluginPush

Push a plugin to the registry.

OnInit
./lib/actions/PluginPush.js
OnStartup
-
OnClose
-

Attributes

-

PluginSet

OnInit
./lib/actions/PluginSet.js
OnStartup
-
OnClose
-

Attributes

-

PluginUpgrade

OnInit
./lib/actions/PluginUpgrade.js
OnStartup
-
OnClose
-

Attributes

-

SecretList

OnInit
./lib/actions/SecretList.js
OnStartup
-
OnClose
-

Attributes

-

SecretCreate

OnInit
./lib/actions/SecretCreate.js
OnStartup
-
OnClose
-

Attributes

-

SecretDelete

OnInit
./lib/actions/SecretDelete.js
OnStartup
-
OnClose
-

Attributes

-

SecretInspect

OnInit
./lib/actions/SecretInspect.js
OnStartup
-
OnClose
-

Attributes

-

SecretUpdate

OnInit
./lib/actions/SecretUpdate.js
OnStartup
-
OnClose
-

Attributes

-

ServiceList

OnInit
./lib/actions/ServiceList.js
OnStartup
-
OnClose
-

Attributes

-

ServiceCreate

OnInit
./lib/actions/ServiceCreate.js
OnStartup
-
OnClose
-

Attributes

-

ServiceDelete

OnInit
./lib/actions/ServiceDelete.js
OnStartup
-
OnClose
-

Attributes

-

ServiceInspect

OnInit
./lib/actions/ServiceInspect.js
OnStartup
-
OnClose
-

Attributes

-

ServiceLogs

Get `stdout` and `stderr` logs from a service. **Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.

OnInit
./lib/actions/ServiceLogs.js
OnStartup
-
OnClose
-

Attributes

-

ServiceUpdate

OnInit
./lib/actions/ServiceUpdate.js
OnStartup
-
OnClose
-

Attributes

-

Session

Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities. > **Note**: This endpoint is *experimental* and only available if the daemon is started with experimental > features enabled. The specifications for this endpoint may still change in a future version of the API. ### Hijacking This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection. For example, the client sends this request to upgrade the connection: ``` POST /session HTTP/1.1 Upgrade: h2c Connection: Upgrade ``` The Docker daemon will respond with a `101 UPGRADED` response follow with the raw stream: ``` HTTP/1.1 101 UPGRADED Connection: Upgrade Upgrade: h2c ```

OnInit
./lib/actions/Session.js
OnStartup
-
OnClose
-

Attributes

-

SwarmInspect

OnInit
./lib/actions/SwarmInspect.js
OnStartup
-
OnClose
-

Attributes

-

SwarmInit

OnInit
./lib/actions/SwarmInit.js
OnStartup
-
OnClose
-

Attributes

-

SwarmJoin

OnInit
./lib/actions/SwarmJoin.js
OnStartup
-
OnClose
-

Attributes

-

SwarmLeave

OnInit
./lib/actions/SwarmLeave.js
OnStartup
-
OnClose
-

Attributes

-

SwarmUnlock

OnInit
./lib/actions/SwarmUnlock.js
OnStartup
-
OnClose
-

Attributes

-

SwarmUnlockkey

OnInit
./lib/actions/SwarmUnlockkey.js
OnStartup
-
OnClose
-

Attributes

-

SwarmUpdate

OnInit
./lib/actions/SwarmUpdate.js
OnStartup
-
OnClose
-

Attributes

-

SystemDataUsage

OnInit
./lib/actions/SystemDataUsage.js
OnStartup
-
OnClose
-

Attributes

-

TaskList

OnInit
./lib/actions/TaskList.js
OnStartup
-
OnClose
-

Attributes

-

TaskInspect

OnInit
./lib/actions/TaskInspect.js
OnStartup
-
OnClose
-

Attributes

-

TaskLogs

Get `stdout` and `stderr` logs from a task. **Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.

OnInit
./lib/actions/TaskLogs.js
OnStartup
-
OnClose
-

Attributes

-

SystemVersion

Returns the version of Docker that is running and various information about the system that Docker is running on.

OnInit
./lib/actions/SystemVersion.js
OnStartup
-
OnClose
-

Attributes

-

VolumeList

OnInit
./lib/actions/VolumeList.js
OnStartup
-
OnClose
-

Attributes

-

VolumeCreate

OnInit
./lib/actions/VolumeCreate.js
OnStartup
-
OnClose
-

Attributes

-

VolumePrune

OnInit
./lib/actions/VolumePrune.js
OnStartup
-
OnClose
-

Attributes

-

VolumeDelete

Instruct the driver to remove the volume.

OnInit
./lib/actions/VolumeDelete.js
OnStartup
-
OnClose
-

Attributes

-

VolumeInspect

OnInit
./lib/actions/VolumeInspect.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden