Skip to content

Instantly share code, notes, and snippets.

@s-h-a-d-o-w

s-h-a-d-o-w/docker.json

Created September 17, 2023 12:34
Show Gist options
  • Save s-h-a-d-o-w/1e6ddd918d93181473883ecd8375d85d to your computer and use it in GitHub Desktop.
Save s-h-a-d-o-w/1e6ddd918d93181473883ecd8375d85d to your computer and use it in GitHub Desktop.
Download ZIP
docker API spec v1.43 converted to OAS3 + regex fix
Raw
docker.json
{
"openapi": "3.0.1",
"info": {
"title": "Docker Engine API",
"description": "The Engine API is an HTTP API served by Docker Engine. It is the API the\nDocker client uses to communicate with the Engine, so everything the Docker\nclient can do can be done with the API.\n\nMost of the client's commands map directly to API endpoints (e.g. `docker ps`\nis `GET /containers/json`). The notable exception is running containers,\nwhich consists of several API calls.\n\n# Errors\n\nThe API uses standard HTTP status codes to indicate the success or failure\nof the API call. The body of the response will be JSON in the following\nformat:\n\n```\n{\n \"message\": \"page not found\"\n}\n```\n\n# Versioning\n\nThe API is usually changed in each release, so API calls are versioned to\nensure that clients don't break. To lock to a specific version of the API,\nyou prefix the URL with its version, for example, call `/v1.30/info` to use\nthe v1.30 version of the `/info` endpoint. If the API version specified in\nthe URL is not supported by the daemon, a HTTP `400 Bad Request` error message\nis returned.\n\nIf you omit the version-prefix, the current version of the API (v1.43) is used.\nFor example, calling `/info` is the same as calling `/v1.43/info`. Using the\nAPI without a version-prefix is deprecated and will be removed in a future release.\n\nEngine releases in the near future should support this version of the API,\nso your client will continue to work even if it is talking to a newer Engine.\n\nThe API uses an open schema model, which means server may add extra properties\nto responses. Likewise, the server will ignore any extra query parameters and\nrequest body properties. When you write clients, you need to ignore additional\nproperties in responses to ensure they do not break when talking to newer\ndaemons.\n\n\n# Authentication\n\nAuthentication for registries is handled client side. The client has to send\nauthentication details to various endpoints that need to communicate with\nregistries, such as `POST /images/(name)/push`. These are sent as\n`X-Registry-Auth` header as a [base64url encoded](https://tools.ietf.org/html/rfc4648#section-5)\n(JSON) string with the following structure:\n\n```\n{\n \"username\": \"string\",\n \"password\": \"string\",\n \"email\": \"string\",\n \"serveraddress\": \"string\"\n}\n```\n\nThe `serveraddress` is a domain/IP without a protocol. Throughout this\nstructure, double quotes are required.\n\nIf you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth),\nyou can just pass this instead of credentials:\n\n```\n{\n \"identitytoken\": \"9cbaf023786cd7...\"\n}\n```\n",
"version": "1.43",
"x-logo": {
"url": "https://docs.docker.com/assets/images/logo-docker-main.png"
}
},
"servers": [
{
"url": "/v1.43"
}
],
"tags": [
{
"name": "Container",
"description": "Create and manage containers.\n",
"x-displayName": "Containers"
},
{
"name": "Image",
"x-displayName": "Images"
},
{
"name": "Network",
"description": "Networks are user-defined networks that containers can be attached to.\nSee the [networking documentation](https://docs.docker.com/network/)\nfor more information.\n",
"x-displayName": "Networks"
},
{
"name": "Volume",
"description": "Create and manage persistent storage that can be attached to containers.\n",
"x-displayName": "Volumes"
},
{
"name": "Exec",
"description": "Run new commands inside running containers. Refer to the\n[command-line reference](https://docs.docker.com/engine/reference/commandline/exec/)\nfor more information.\n\nTo exec a command in a container, you first need to create an exec instance,\nthen start it. These two API endpoints are wrapped up in a single command-line\ncommand, `docker exec`.\n",
"x-displayName": "Exec"
},
{
"name": "Swarm",
"description": "Engines can be clustered together in a swarm. Refer to the\n[swarm mode documentation](https://docs.docker.com/engine/swarm/)\nfor more information.\n",
"x-displayName": "Swarm"
},
{
"name": "Node",
"description": "Nodes are instances of the Engine participating in a swarm. Swarm mode\nmust be enabled for these endpoints to work.\n",
"x-displayName": "Nodes"
},
{
"name": "Service",
"description": "Services are the definitions of tasks to run on a swarm. Swarm mode must\nbe enabled for these endpoints to work.\n",
"x-displayName": "Services"
},
{
"name": "Task",
"description": "A task is a container running on a swarm. It is the atomic scheduling unit\nof swarm. Swarm mode must be enabled for these endpoints to work.\n",
"x-displayName": "Tasks"
},
{
"name": "Secret",
"description": "Secrets are sensitive data that can be used by services. Swarm mode must\nbe enabled for these endpoints to work.\n",
"x-displayName": "Secrets"
},
{
"name": "Config",
"description": "Configs are application configurations that can be used by services. Swarm\nmode must be enabled for these endpoints to work.\n",
"x-displayName": "Configs"
},
{
"name": "Plugin",
"x-displayName": "Plugins"
},
{
"name": "System",
"x-displayName": "System"
}
],
"paths": {
"/containers/json": {
"get": {
"tags": [
"Container"
],
"summary": "List containers",
"description": "Returns a list of containers. For details on the format, see the\n[inspect endpoint](#operation/ContainerInspect).\n\nNote that it uses a different, smaller representation of a container\nthan inspecting a single container. For example, the list of linked\ncontainers is not propagated .\n",
"operationId": "ContainerList",
"parameters": [
{
"name": "all",
"in": "query",
"description": "Return all containers. By default, only running containers are shown.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "limit",
"in": "query",
"description": "Return this number of most recently created containers, including\nnon-running ones.\n",
"schema": {
"type": "integer"
}
},
{
"name": "size",
"in": "query",
"description": "Return the size of container as fields `SizeRw` and `SizeRootFs`.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "filters",
"in": "query",
"description": "Filters to process on the container list, encoded as JSON (a\n`map[string][]string`). For example, `{\"status\": [\"paused\"]}` will\nonly return paused containers.\n\nAvailable filters:\n\n- `ancestor`=(`<image-name>[:<tag>]`, `<image id>`, or `<image@digest>`)\n- `before`=(`<container id>` or `<container name>`)\n- `expose`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)\n- `exited=<int>` containers with exit code of `<int>`\n- `health`=(`starting`|`healthy`|`unhealthy`|`none`)\n- `id=<ID>` a container's ID\n- `isolation=`(`default`|`process`|`hyperv`) (Windows daemon only)\n- `is-task=`(`true`|`false`)\n- `label=key` or `label=\"key=value\"` of a container label\n- `name=<name>` a container's name\n- `network`=(`<network id>` or `<network name>`)\n- `publish`=(`<port>[/<proto>]`|`<startport-endport>/[<proto>]`)\n- `since`=(`<container id>` or `<container name>`)\n- `status=`(`created`|`restarting`|`running`|`removing`|`paused`|`exited`|`dead`)\n- `volume`=(`<volume name>` or `<mount point destination>`)\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContainerSummary"
}
},
"example": [
{
"Id": "8dfafdbc3a40",
"Names": [
"/boring_feynman"
],
"Image": "ubuntu:latest",
"ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
"Command": "echo 1",
"Created": 1367854155,
"State": "Exited",
"Status": "Exit 0",
"Ports": [
{
"PrivatePort": 2222,
"PublicPort": 3333,
"Type": "tcp"
}
],
"Labels": {
"com.example.vendor": "Acme",
"com.example.license": "GPL",
"com.example.version": "1.0"
},
"SizeRw": 12288,
"SizeRootFs": 0,
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
"EndpointID": "2cdc4edb1ded3631c81f57966563e5c8525b81121bb3706a9a9a3ae102711f3f",
"Gateway": "172.17.0.1",
"IPAddress": "172.17.0.2",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:11:00:02"
}
}
},
"Mounts": [
{
"Name": "fac362...80535",
"Source": "/data",
"Destination": "/data",
"Driver": "local",
"Mode": "ro,Z",
"RW": false,
"Propagation": ""
}
]
},
{
"Id": "9cd87474be90",
"Names": [
"/coolName"
],
"Image": "ubuntu:latest",
"ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
"Command": "echo 222222",
"Created": 1367854155,
"State": "Exited",
"Status": "Exit 0",
"Ports": [],
"Labels": {},
"SizeRw": 12288,
"SizeRootFs": 0,
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
"EndpointID": "88eaed7b37b38c2a3f0c4bc796494fdf51b270c2d22656412a2ca5d559a64d7a",
"Gateway": "172.17.0.1",
"IPAddress": "172.17.0.8",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:11:00:08"
}
}
},
"Mounts": []
},
{
"Id": "3176a2479c92",
"Names": [
"/sleepy_dog"
],
"Image": "ubuntu:latest",
"ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
"Command": "echo 3333333333333333",
"Created": 1367854154,
"State": "Exited",
"Status": "Exit 0",
"Ports": [],
"Labels": {},
"SizeRw": 12288,
"SizeRootFs": 0,
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
"EndpointID": "8b27c041c30326d59cd6e6f510d4f8d1d570a228466f956edf7815508f78e30d",
"Gateway": "172.17.0.1",
"IPAddress": "172.17.0.6",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:11:00:06"
}
}
},
"Mounts": []
},
{
"Id": "4cb07b47f9fb",
"Names": [
"/running_cat"
],
"Image": "ubuntu:latest",
"ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
"Command": "echo 444444444444444444444444444444444",
"Created": 1367854152,
"State": "Exited",
"Status": "Exit 0",
"Ports": [],
"Labels": {},
"SizeRw": 12288,
"SizeRootFs": 0,
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
"EndpointID": "d91c7b2f0644403d7ef3095985ea0e2370325cd2332ff3a3225c4247328e66e9",
"Gateway": "172.17.0.1",
"IPAddress": "172.17.0.5",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:11:00:05"
}
}
},
"Mounts": []
}
]
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/create": {
"post": {
"tags": [
"Container"
],
"summary": "Create a container",
"operationId": "ContainerCreate",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Assign the specified name to the container. Must match\n`\/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.\n",
"schema": {
"pattern": "^\\/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$",
"type": "string"
}
},
{
"name": "platform",
"in": "query",
"description": "Platform in the format `os[/arch[/variant]]` used for image lookup.\n\nWhen specified, the daemon checks if the requested image is present\nin the local image cache with the given OS and Architecture, and\notherwise returns a `404` status.\n\nIf the option is not set, the host's native OS and Architecture are\nused to look up the image in the image cache. However, if no platform\nis passed and the given image does exist in the local image cache,\nbut its OS or architecture does not match, the container is created\nwith the available image, and a warning is added to the `Warnings`\nfield in the response, for example;\n\n WARNING: The requested image's platform (linux/arm64/v8) does not\n match the detected host platform (linux/amd64) and no\n specific platform was requested\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Container to create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContainerConfig"
},
{
"type": "object",
"properties": {
"HostConfig": {
"$ref": "#/components/schemas/HostConfig"
},
"NetworkingConfig": {
"$ref": "#/components/schemas/NetworkingConfig"
}
}
}
]
}
},
"application/octet-stream": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ContainerConfig"
},
{
"type": "object",
"properties": {
"HostConfig": {
"$ref": "#/components/schemas/HostConfig"
},
"NetworkingConfig": {
"$ref": "#/components/schemas/NetworkingConfig"
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Container created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerCreateResponse"
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such image: c2ada9df5af8"
}
}
}
},
"409": {
"description": "conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/containers/{id}/json": {
"get": {
"tags": [
"Container"
],
"summary": "Inspect a container",
"description": "Return low-level information about a container.",
"operationId": "ContainerInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "Return the size of container as fields `SizeRw` and `SizeRootFs`",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"title": "ContainerInspectResponse",
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of the container"
},
"Created": {
"type": "string",
"description": "The time the container was created"
},
"Path": {
"type": "string",
"description": "The path to the command being run"
},
"Args": {
"type": "array",
"description": "The arguments to the command being run",
"items": {
"type": "string"
}
},
"State": {
"$ref": "#/components/schemas/ContainerState"
},
"Image": {
"type": "string",
"description": "The container's image ID"
},
"ResolvConfPath": {
"type": "string"
},
"HostnamePath": {
"type": "string"
},
"HostsPath": {
"type": "string"
},
"LogPath": {
"type": "string"
},
"Name": {
"type": "string"
},
"RestartCount": {
"type": "integer"
},
"Driver": {
"type": "string"
},
"Platform": {
"type": "string"
},
"MountLabel": {
"type": "string"
},
"ProcessLabel": {
"type": "string"
},
"AppArmorProfile": {
"type": "string"
},
"ExecIDs": {
"type": "array",
"description": "IDs of exec instances that are running in the container.",
"nullable": true,
"items": {
"type": "string"
}
},
"HostConfig": {
"$ref": "#/components/schemas/HostConfig"
},
"GraphDriver": {
"$ref": "#/components/schemas/GraphDriverData"
},
"SizeRw": {
"type": "integer",
"description": "The size of files that have been created or changed by this\ncontainer.\n",
"format": "int64"
},
"SizeRootFs": {
"type": "integer",
"description": "The total size of all the files in this container.",
"format": "int64"
},
"Mounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MountPoint"
}
},
"Config": {
"$ref": "#/components/schemas/ContainerConfig"
},
"NetworkSettings": {
"$ref": "#/components/schemas/NetworkSettings"
}
}
},
"example": {
"AppArmorProfile": "",
"Args": [
"-c",
"exit 9"
],
"Config": {
"AttachStderr": true,
"AttachStdin": false,
"AttachStdout": true,
"Cmd": [
"/bin/sh",
"-c",
"exit 9"
],
"Domainname": "",
"Env": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"Healthcheck": {
"Test": [
"CMD-SHELL",
"exit 0"
]
},
"Hostname": "ba033ac44011",
"Image": "ubuntu",
"Labels": {
"com.example.vendor": "Acme",
"com.example.license": "GPL",
"com.example.version": "1.0"
},
"MacAddress": "",
"NetworkDisabled": false,
"OpenStdin": false,
"StdinOnce": false,
"Tty": false,
"User": "",
"Volumes": {
"/volumes/data": {}
},
"WorkingDir": "",
"StopSignal": "SIGTERM",
"StopTimeout": 10
},
"Created": "2015-01-06T15:47:31.485331387Z",
"Driver": "devicemapper",
"ExecIDs": [
"b35395de42bc8abd327f9dd65d913b9ba28c74d2f0734eeeae84fa1c616a0fca",
"3fc1232e5cd20c8de182ed81178503dc6437f4e7ef12b52cc5e8de020652f1c4"
],
"HostConfig": {
"MaximumIOps": 0,
"MaximumIOBps": 0,
"BlkioWeight": 0,
"BlkioWeightDevice": [
{}
],
"BlkioDeviceReadBps": [
{}
],
"BlkioDeviceWriteBps": [
{}
],
"BlkioDeviceReadIOps": [
{}
],
"BlkioDeviceWriteIOps": [
{}
],
"ContainerIDFile": "",
"CpusetCpus": "",
"CpusetMems": "",
"CpuPercent": 80,
"CpuShares": 0,
"CpuPeriod": 100000,
"CpuRealtimePeriod": 1000000,
"CpuRealtimeRuntime": 10000,
"Devices": [],
"DeviceRequests": [
{
"Driver": "nvidia",
"Count": -1,
"DeviceIDs\"": [
"0",
"1",
"GPU-fef8089b-4820-abfc-e83e-94318197576e"
],
"Capabilities": [
[
"gpu",
"nvidia",
"compute"
]
],
"Options": {
"property1": "string",
"property2": "string"
}
}
],
"IpcMode": "",
"Memory": 0,
"MemorySwap": 0,
"MemoryReservation": 0,
"OomKillDisable": false,
"OomScoreAdj": 500,
"NetworkMode": "bridge",
"PidMode": "",
"PortBindings": {},
"Privileged": false,
"ReadonlyRootfs": false,
"PublishAllPorts": false,
"RestartPolicy": {
"MaximumRetryCount": 2,
"Name": "on-failure"
},
"LogConfig": {
"Type": "json-file"
},
"Sysctls": {
"net.ipv4.ip_forward": "1"
},
"Ulimits": [
{}
],
"VolumeDriver": "",
"ShmSize": 67108864
},
"HostnamePath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname",
"HostsPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts",
"LogPath": "/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log",
"Id": "ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39",
"Image": "04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2",
"MountLabel": "",
"Name": "/boring_euclid",
"NetworkSettings": {
"Bridge": "",
"SandboxID": "",
"HairpinMode": false,
"LinkLocalIPv6Address": "",
"LinkLocalIPv6PrefixLen": 0,
"SandboxKey": "",
"EndpointID": "",
"Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"IPAddress": "",
"IPPrefixLen": 0,
"IPv6Gateway": "",
"MacAddress": "",
"Networks": {
"bridge": {
"NetworkID": "7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
"EndpointID": "7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d",
"Gateway": "172.17.0.1",
"IPAddress": "172.17.0.2",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:12:00:02"
}
}
},
"Path": "/bin/sh",
"ProcessLabel": "",
"ResolvConfPath": "/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf",
"RestartCount": 1,
"State": {
"Error": "",
"ExitCode": 9,
"FinishedAt": "2015-01-06T15:47:32.080254511Z",
"Health": {
"Status": "healthy",
"FailingStreak": 0,
"Log": [
{
"Start": "2019-12-22T10:59:05.6385933Z",
"End": "2019-12-22T10:59:05.8078452Z",
"ExitCode": 0,
"Output": ""
}
]
},
"OOMKilled": false,
"Dead": false,
"Paused": false,
"Pid": 0,
"Restarting": false,
"Running": true,
"StartedAt": "2015-01-06T15:47:32.072697474Z",
"Status": "running"
},
"Mounts": [
{
"Name": "fac362...80535",
"Source": "/data",
"Destination": "/data",
"Driver": "local",
"Mode": "ro,Z",
"RW": false,
"Propagation": ""
}
]
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/top": {
"get": {
"tags": [
"Container"
],
"summary": "List processes running inside a container",
"description": "On Unix systems, this is done by running the `ps` command. This endpoint\nis not supported on Windows.\n",
"operationId": "ContainerTop",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ps_args",
"in": "query",
"description": "The arguments to pass to `ps`. For example, `aux`",
"schema": {
"type": "string",
"default": "-ef"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"title": "ContainerTopResponse",
"type": "object",
"properties": {
"Titles": {
"type": "array",
"description": "The ps column titles",
"items": {
"type": "string"
}
},
"Processes": {
"type": "array",
"description": "Each process running in the container, where each is process\nis an array of values corresponding to the titles.\n",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"description": "OK response to ContainerTop operation"
},
"example": {
"Titles": [
"UID",
"PID",
"PPID",
"C",
"STIME",
"TTY",
"TIME",
"CMD"
],
"Processes": [
[
"root",
"13642",
"882",
"0",
"17:03",
"pts/0",
"00:00:00",
"/bin/bash"
],
[
"root",
"13735",
"13642",
"0",
"17:06",
"pts/0",
"00:00:00",
"sleep 10"
]
]
}
},
"text/plain": {
"schema": {
"title": "ContainerTopResponse",
"type": "object",
"properties": {
"Titles": {
"type": "array",
"description": "The ps column titles",
"items": {
"type": "string"
}
},
"Processes": {
"type": "array",
"description": "Each process running in the container, where each is process\nis an array of values corresponding to the titles.\n",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"description": "OK response to ContainerTop operation"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/logs": {
"get": {
"tags": [
"Container"
],
"summary": "Get container logs",
"description": "Get `stdout` and `stderr` logs from a container.\n\nNote: This endpoint works only for containers with the `json-file` or\n`journald` logging driver.\n",
"operationId": "ContainerLogs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "follow",
"in": "query",
"description": "Keep connection after returning logs.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdout",
"in": "query",
"description": "Return logs from `stdout`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stderr",
"in": "query",
"description": "Return logs from `stderr`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "since",
"in": "query",
"description": "Only return logs since this time, as a UNIX timestamp",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "until",
"in": "query",
"description": "Only return logs before this time, as a UNIX timestamp",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "timestamps",
"in": "query",
"description": "Add timestamps to every log line",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tail",
"in": "query",
"description": "Only return this number of log lines from the end of the logs.\nSpecify as an integer or `all` to output all log lines.\n",
"schema": {
"type": "string",
"default": "all"
}
}
],
"responses": {
"200": {
"description": "logs returned as a stream in response body.\nFor the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).\nNote that unlike the attach endpoint, the logs endpoint does not\nupgrade the connection and does not set Content-Type.\n",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/changes": {
"get": {
"tags": [
"Container"
],
"summary": "Get changes on a container’s filesystem",
"description": "Returns which files in a container's filesystem have been added, deleted,\nor modified. The `Kind` of modification can be one of:\n\n- `0`: Modified (\"C\")\n- `1`: Added (\"A\")\n- `2`: Deleted (\"D\")\n",
"operationId": "ContainerChanges",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The list of changes",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilesystemChange"
}
},
"example": [
{
"Path": "/dev",
"Kind": 0
},
{
"Path": "/dev/kmsg",
"Kind": 1
},
{
"Path": "/test",
"Kind": 1
}
]
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/export": {
"get": {
"tags": [
"Container"
],
"summary": "Export a container",
"description": "Export the contents of a container as a tarball.",
"operationId": "ContainerExport",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/stats": {
"get": {
"tags": [
"Container"
],
"summary": "Get container stats based on resource usage",
"description": "This endpoint returns a live stream of a container’s resource usage\nstatistics.\n\nThe `precpu_stats` is the CPU statistic of the *previous* read, and is\nused to calculate the CPU usage percentage. It is not an exact copy\nof the `cpu_stats` field.\n\nIf either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is\nnil then for compatibility with older daemons the length of the\ncorresponding `cpu_usage.percpu_usage` array should be used.\n\nOn a cgroup v2 host, the following fields are not set\n* `blkio_stats`: all fields other than `io_service_bytes_recursive`\n* `cpu_stats`: `cpu_usage.percpu_usage`\n* `memory_stats`: `max_usage` and `failcnt`\nAlso, `memory_stats.stats` fields are incompatible with cgroup v1.\n\nTo calculate the values shown by the `stats` command of the docker cli tool\nthe following formulas can be used:\n* used_memory = `memory_stats.usage - memory_stats.stats.cache`\n* available_memory = `memory_stats.limit`\n* Memory usage % = `(used_memory / available_memory) * 100.0`\n* cpu_delta = `cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage`\n* system_cpu_delta = `cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage`\n* number_cpus = `lenght(cpu_stats.cpu_usage.percpu_usage)` or `cpu_stats.online_cpus`\n* CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`\n",
"operationId": "ContainerStats",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "stream",
"in": "query",
"description": "Stream the output. If false, the stats will be output once and then\nit will disconnect.\n",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "one-shot",
"in": "query",
"description": "Only get a single stat instead of waiting for 2 cycles. Must be used\nwith `stream=false`.\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {
"read": "2015-01-08T22:57:31.547920715Z",
"pids_stats": {
"current": 3
},
"networks": {
"eth0": {
"rx_bytes": 5338,
"rx_dropped": 0,
"rx_errors": 0,
"rx_packets": 36,
"tx_bytes": 648,
"tx_dropped": 0,
"tx_errors": 0,
"tx_packets": 8
},
"eth5": {
"rx_bytes": 4641,
"rx_dropped": 0,
"rx_errors": 0,
"rx_packets": 26,
"tx_bytes": 690,
"tx_dropped": 0,
"tx_errors": 0,
"tx_packets": 9
}
},
"memory_stats": {
"stats": {
"total_pgmajfault": 0,
"cache": 0,
"mapped_file": 0,
"total_inactive_file": 0,
"pgpgout": 414,
"rss": 6537216,
"total_mapped_file": 0,
"writeback": 0,
"unevictable": 0,
"pgpgin": 477,
"total_unevictable": 0,
"pgmajfault": 0,
"total_rss": 6537216,
"total_rss_huge": 6291456,
"total_writeback": 0,
"total_inactive_anon": 0,
"rss_huge": 6291456,
"hierarchical_memory_limit": 67108864,
"total_pgfault": 964,
"total_active_file": 0,
"active_anon": 6537216,
"total_active_anon": 6537216,
"total_pgpgout": 414,
"total_cache": 0,
"inactive_anon": 0,
"active_file": 0,
"pgfault": 964,
"inactive_file": 0,
"total_pgpgin": 477
},
"max_usage": 6651904,
"usage": 6537216,
"failcnt": 0,
"limit": 67108864
},
"blkio_stats": {},
"cpu_stats": {
"cpu_usage": {
"percpu_usage": [
8646879,
24472255,
36438778,
30657443
],
"usage_in_usermode": 50000000,
"total_usage": 100215355,
"usage_in_kernelmode": 30000000
},
"system_cpu_usage": 739306590000000,
"online_cpus": 4,
"throttling_data": {
"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
},
"precpu_stats": {
"cpu_usage": {
"percpu_usage": [
8646879,
24350896,
36438778,
30657443
],
"usage_in_usermode": 50000000,
"total_usage": 100093996,
"usage_in_kernelmode": 30000000
},
"system_cpu_usage": 9492140000000,
"online_cpus": 4,
"throttling_data": {
"periods": 0,
"throttled_periods": 0,
"throttled_time": 0
}
}
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/resize": {
"post": {
"tags": [
"Container"
],
"summary": "Resize a container TTY",
"description": "Resize the TTY for a container.",
"operationId": "ContainerResize",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "h",
"in": "query",
"description": "Height of the TTY session in characters",
"schema": {
"type": "integer"
}
},
{
"name": "w",
"in": "query",
"description": "Width of the TTY session in characters",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "cannot resize container",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/start": {
"post": {
"tags": [
"Container"
],
"summary": "Start a container",
"operationId": "ContainerStart",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "detachKeys",
"in": "query",
"description": "Override the key sequence for detaching a container. Format is a\nsingle character `[a-Z]` or `ctrl-<value>` where `<value>` is one\nof: `a-z`, `@`, `^`, `[`, `,` or `_`.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"304": {
"description": "container already started",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/stop": {
"post": {
"tags": [
"Container"
],
"summary": "Stop a container",
"operationId": "ContainerStop",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "signal",
"in": "query",
"description": "Signal to send to the container as an integer or string (e.g. `SIGINT`).\n",
"schema": {
"type": "string"
}
},
{
"name": "t",
"in": "query",
"description": "Number of seconds to wait before killing the container",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"304": {
"description": "container already stopped",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/restart": {
"post": {
"tags": [
"Container"
],
"summary": "Restart a container",
"operationId": "ContainerRestart",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "signal",
"in": "query",
"description": "Signal to send to the container as an integer or string (e.g. `SIGINT`).\n",
"schema": {
"type": "string"
}
},
{
"name": "t",
"in": "query",
"description": "Number of seconds to wait before killing the container",
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/kill": {
"post": {
"tags": [
"Container"
],
"summary": "Kill a container",
"description": "Send a POSIX signal to a container, defaulting to killing to the\ncontainer.\n",
"operationId": "ContainerKill",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "signal",
"in": "query",
"description": "Signal to send to the container as an integer or string (e.g. `SIGINT`).\n",
"schema": {
"type": "string",
"default": "SIGKILL"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "container is not running",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Container d37cde0fe4ad63c3a7252023b2f9800282894247d145cb5933ddf6e52cc03a28 is not running"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/update": {
"post": {
"tags": [
"Container"
],
"summary": "Update a container",
"description": "Change various configuration options of a container without having to\nrecreate it.\n",
"operationId": "ContainerUpdate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Resources"
},
{
"type": "object",
"properties": {
"RestartPolicy": {
"$ref": "#/components/schemas/RestartPolicy"
}
}
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The container has been updated.",
"content": {
"application/json": {
"schema": {
"title": "ContainerUpdateResponse",
"type": "object",
"properties": {
"Warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "OK response to ContainerUpdate operation"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "update"
}
},
"/containers/{id}/rename": {
"post": {
"tags": [
"Container"
],
"summary": "Rename a container",
"operationId": "ContainerRename",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "New name for the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "name already in use",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/pause": {
"post": {
"tags": [
"Container"
],
"summary": "Pause a container",
"description": "Use the freezer cgroup to suspend all processes in a container.\n\nTraditionally, when suspending a process the `SIGSTOP` signal is used,\nwhich is observable by the process being suspended. With the freezer\ncgroup the process is unaware, and unable to capture, that it is being\nsuspended, and subsequently resumed.\n",
"operationId": "ContainerPause",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/unpause": {
"post": {
"tags": [
"Container"
],
"summary": "Unpause a container",
"description": "Resume a container which has been paused.",
"operationId": "ContainerUnpause",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/attach": {
"post": {
"tags": [
"Container"
],
"summary": "Attach to a container",
"description": "Attach to a container to read its output or send it input. You can attach\nto the same container multiple times and you can reattach to containers\nthat have been detached.\n\nEither the `stream` or `logs` parameter must be `true` for this endpoint\nto do anything.\n\nSee the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)\nfor more details.\n\n### Hijacking\n\nThis endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,\nand `stderr` on the same socket.\n\nThis is the response from the daemon for an attach request:\n\n```\nHTTP/1.1 200 OK\nContent-Type: application/vnd.docker.raw-stream\n\n[STREAM]\n```\n\nAfter the headers and two new lines, the TCP connection can now be used\nfor raw, bidirectional communication between the client and server.\n\nTo hint potential proxies about connection hijacking, the Docker client\ncan also optionally send connection upgrade headers.\n\nFor example, the client sends this request to upgrade the connection:\n\n```\nPOST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1\nUpgrade: tcp\nConnection: Upgrade\n```\n\nThe Docker daemon will respond with a `101 UPGRADED` response, and will\nsimilarly follow with the raw stream:\n\n```\nHTTP/1.1 101 UPGRADED\nContent-Type: application/vnd.docker.raw-stream\nConnection: Upgrade\nUpgrade: tcp\n\n[STREAM]\n```\n\n### Stream format\n\nWhen the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),\nthe HTTP Content-Type header is set to application/vnd.docker.multiplexed-stream\nand the stream over the hijacked connected is multiplexed to separate out\n`stdout` and `stderr`. The stream consists of a series of frames, each\ncontaining a header and a payload.\n\nThe header contains the information which the stream writes (`stdout` or\n`stderr`). It also contains the size of the associated frame encoded in\nthe last four bytes (`uint32`).\n\nIt is encoded on the first eight bytes like this:\n\n```go\nheader := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}\n```\n\n`STREAM_TYPE` can be:\n\n- 0: `stdin` (is written on `stdout`)\n- 1: `stdout`\n- 2: `stderr`\n\n`SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size\nencoded as big endian.\n\nFollowing the header is the payload, which is the specified number of\nbytes of `STREAM_TYPE`.\n\nThe simplest way to implement this protocol is the following:\n\n1. Read 8 bytes.\n2. Choose `stdout` or `stderr` depending on the first byte.\n3. Extract the frame size from the last four bytes.\n4. Read the extracted size and output it on the correct output.\n5. Goto 1.\n\n### Stream format when using a TTY\n\nWhen the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),\nthe stream is not multiplexed. The data exchanged over the hijacked\nconnection is simply the raw data from the process PTY and client's\n`stdin`.\n",
"operationId": "ContainerAttach",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "detachKeys",
"in": "query",
"description": "Override the key sequence for detaching a container.Format is a single\ncharacter `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`,\n`@`, `^`, `[`, `,` or `_`.\n",
"schema": {
"type": "string"
}
},
{
"name": "logs",
"in": "query",
"description": "Replay previous logs from the container.\n\nThis is useful for attaching to a container that has started and you\nwant to output everything since the container started.\n\nIf `stream` is also enabled, once all the previous output has been\nreturned, it will seamlessly transition into streaming current\noutput.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stream",
"in": "query",
"description": "Stream attached streams from the time the request was made onwards.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdin",
"in": "query",
"description": "Attach to `stdin`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdout",
"in": "query",
"description": "Attach to `stdout`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stderr",
"in": "query",
"description": "Attach to `stderr`",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"101": {
"description": "no error, hints proxy about hijacking",
"content": {}
},
"200": {
"description": "no error, no upgrade header found",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/attach/ws": {
"get": {
"tags": [
"Container"
],
"summary": "Attach to a container via a websocket",
"operationId": "ContainerAttachWebsocket",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "detachKeys",
"in": "query",
"description": "Override the key sequence for detaching a container.Format is a single\ncharacter `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`,\n`@`, `^`, `[`, `,`, or `_`.\n",
"schema": {
"type": "string"
}
},
{
"name": "logs",
"in": "query",
"description": "Return logs",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stream",
"in": "query",
"description": "Return stream",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdin",
"in": "query",
"description": "Attach to `stdin`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdout",
"in": "query",
"description": "Attach to `stdout`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stderr",
"in": "query",
"description": "Attach to `stderr`",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"101": {
"description": "no error, hints proxy about hijacking",
"content": {}
},
"200": {
"description": "no error, no upgrade header found",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/wait": {
"post": {
"tags": [
"Container"
],
"summary": "Wait for a container",
"description": "Block until a container stops, then returns the exit code.",
"operationId": "ContainerWait",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "condition",
"in": "query",
"description": "Wait until a container state reaches the given condition.\n\nDefaults to `not-running` if omitted or empty.\n",
"schema": {
"type": "string",
"default": "not-running",
"enum": [
"not-running",
"next-exit",
"removed"
]
}
}
],
"responses": {
"200": {
"description": "The container has exit.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerWaitResponse"
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}": {
"delete": {
"tags": [
"Container"
],
"summary": "Remove a container",
"operationId": "ContainerDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "v",
"in": "query",
"description": "Remove anonymous volumes associated with the container.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "force",
"in": "query",
"description": "If the container is running, kill it before removing it.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "link",
"in": "query",
"description": "Remove the specified link associated with the container.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "You cannot remove a running container: c2ada9df5af8. Stop the\ncontainer before attempting removal or force remove\n"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/{id}/archive": {
"get": {
"tags": [
"Container"
],
"summary": "Get an archive of a filesystem resource in a container",
"description": "Get a tar archive of a resource in the filesystem of container id.",
"operationId": "ContainerArchive",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "path",
"in": "query",
"description": "Resource in the container’s filesystem to archive.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "Bad parameter",
"content": {
"application/x-tar": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Container or path does not exist",
"content": {
"application/x-tar": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/x-tar": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Container"
],
"summary": "Extract an archive of files or folders to a directory in a container",
"description": "Upload a tar archive to be extracted to a path in the filesystem of container id.\n`path` parameter is asserted to be a directory. If it exists as a file, 400 error\nwill be returned with message \"not a directory\".\n",
"operationId": "PutContainerArchive",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "path",
"in": "query",
"description": "Path to a directory in the container to extract the archive’s contents into. ",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "noOverwriteDirNonDir",
"in": "query",
"description": "If `1`, `true`, or `True` then it will be an error if unpacking the\ngiven content would cause an existing directory to be replaced with\na non-directory and vice versa.\n",
"schema": {
"type": "string"
}
},
{
"name": "copyUIDGID",
"in": "query",
"description": "If `1`, `true`, then it will copy UID/GID maps to the dest file or\ndir\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The input stream must be a tar archive compressed with one of the\nfollowing algorithms: `identity` (no compression), `gzip`, `bzip2`,\nor `xz`.\n",
"content": {
"application/x-tar": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The content was extracted successfully",
"content": {}
},
"400": {
"description": "Bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "not a directory"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Permission denied, the volume or container rootfs is marked as read-only.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "No such container or path does not exist inside the container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "inputStream"
},
"head": {
"tags": [
"Container"
],
"summary": "Get information about files in a container",
"description": "A response header `X-Docker-Container-Path-Stat` is returned, containing\na base64 - encoded JSON object with some filesystem header information\nabout the path.\n",
"operationId": "ContainerArchiveInfo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the container",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "path",
"in": "query",
"description": "Resource in the container’s filesystem to archive.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"headers": {
"X-Docker-Container-Path-Stat": {
"description": "A base64 - encoded JSON object with some filesystem header\ninformation about the path\n",
"schema": {
"type": "string"
}
}
},
"content": {}
},
"400": {
"description": "Bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Container or path does not exist",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/containers/prune": {
"post": {
"tags": [
"Container"
],
"summary": "Delete stopped containers",
"operationId": "ContainerPrune",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\nAvailable filters:\n- `until=<timestamp>` Prune containers created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune containers with (or without, in case `label!=...` is used) the specified labels.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "ContainerPruneResponse",
"type": "object",
"properties": {
"ContainersDeleted": {
"type": "array",
"description": "Container IDs that were deleted",
"items": {
"type": "string"
}
},
"SpaceReclaimed": {
"type": "integer",
"description": "Disk space reclaimed in bytes",
"format": "int64"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/json": {
"get": {
"tags": [
"Image"
],
"summary": "List Images",
"description": "Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.",
"operationId": "ImageList",
"parameters": [
{
"name": "all",
"in": "query",
"description": "Show all images. Only images from a final layer (no children) are shown by default.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the images list.\n\nAvailable filters:\n\n- `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)\n- `dangling=true`\n- `label=key` or `label=\"key=value\"` of an image label\n- `reference`=(`<image-name>[:<tag>]`)\n- `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)\n",
"schema": {
"type": "string"
}
},
{
"name": "shared-size",
"in": "query",
"description": "Compute and show shared size as a `SharedSize` field on each image.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "digests",
"in": "query",
"description": "Show digest information as a `RepoDigests` field on each image.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Summary image data for the images matching the query",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageSummary"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/build": {
"post": {
"tags": [
"Image"
],
"summary": "Build an image",
"description": "Build an image from a tar archive with a `Dockerfile` in it.\n\nThe `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/).\n\nThe 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.\n\nThe build is canceled if the client drops the connection by quitting or being killed.\n",
"operationId": "ImageBuild",
"parameters": [
{
"name": "dockerfile",
"in": "query",
"description": "Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.",
"schema": {
"type": "string",
"default": "Dockerfile"
}
},
{
"name": "t",
"in": "query",
"description": "A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.",
"schema": {
"type": "string"
}
},
{
"name": "extrahosts",
"in": "query",
"description": "Extra hosts to add to /etc/hosts",
"schema": {
"type": "string"
}
},
{
"name": "remote",
"in": "query",
"description": "A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.",
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "Suppress verbose build output.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "nocache",
"in": "query",
"description": "Do not use the cache when building the image.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "cachefrom",
"in": "query",
"description": "JSON array of images used for build cache resolution.",
"schema": {
"type": "string"
}
},
{
"name": "pull",
"in": "query",
"description": "Attempt to pull the image even if an older image exists locally.",
"schema": {
"type": "string"
}
},
{
"name": "rm",
"in": "query",
"description": "Remove intermediate containers after a successful build.",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "forcerm",
"in": "query",
"description": "Always remove intermediate containers, even upon failure.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "memory",
"in": "query",
"description": "Set memory limit for build.",
"schema": {
"type": "integer"
}
},
{
"name": "memswap",
"in": "query",
"description": "Total memory (memory + swap). Set as `-1` to disable swap.",
"schema": {
"type": "integer"
}
},
{
"name": "cpushares",
"in": "query",
"description": "CPU shares (relative weight).",
"schema": {
"type": "integer"
}
},
{
"name": "cpusetcpus",
"in": "query",
"description": "CPUs in which to allow execution (e.g., `0-3`, `0,1`).",
"schema": {
"type": "string"
}
},
{
"name": "cpuperiod",
"in": "query",
"description": "The length of a CPU period in microseconds.",
"schema": {
"type": "integer"
}
},
{
"name": "cpuquota",
"in": "query",
"description": "Microseconds of CPU time that the container can get in a CPU period.",
"schema": {
"type": "integer"
}
},
{
"name": "buildargs",
"in": "query",
"description": "JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values.\n\nFor example, the build arg `FOO=bar` would become `{\"FOO\":\"bar\"}` in JSON. This would result in the query parameter `buildargs={\"FOO\":\"bar\"}`. Note that `{\"FOO\":\"bar\"}` should be URI component encoded.\n\n[Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)\n",
"schema": {
"type": "string"
}
},
{
"name": "shmsize",
"in": "query",
"description": "Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.",
"schema": {
"type": "integer"
}
},
{
"name": "squash",
"in": "query",
"description": "Squash the resulting images layers into a single layer. *(Experimental release only.)*",
"schema": {
"type": "boolean"
}
},
{
"name": "labels",
"in": "query",
"description": "Arbitrary key/value labels to set on the image, as a JSON map of string pairs.",
"schema": {
"type": "string"
}
},
{
"name": "networkmode",
"in": "query",
"description": "Sets the networking mode for the run commands during build. Supported\nstandard values are: `bridge`, `host`, `none`, and `container:<name|id>`.\nAny other value is taken as a custom network's name or ID to which this\ncontainer should connect to.\n",
"schema": {
"type": "string"
}
},
{
"name": "Content-type",
"in": "header",
"schema": {
"type": "string",
"default": "application/x-tar",
"enum": [
"application/x-tar"
]
}
},
{
"name": "X-Registry-Config",
"in": "header",
"description": "This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.\n\nThe key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:\n\n```\n{\n \"docker.example.com\": {\n \"username\": \"janedoe\",\n \"password\": \"hunter2\"\n },\n \"https://index.docker.io/v1/\": {\n \"username\": \"mobydock\",\n \"password\": \"conta1n3rize14\"\n }\n}\n```\n\nOnly the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.\n",
"schema": {
"type": "string"
}
},
{
"name": "platform",
"in": "query",
"description": "Platform in the format os[/arch[/variant]]",
"schema": {
"type": "string"
}
},
{
"name": "target",
"in": "query",
"description": "Target build stage",
"schema": {
"type": "string"
}
},
{
"name": "outputs",
"in": "query",
"description": "BuildKit output configuration",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz.",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "Bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "inputStream"
}
},
"/build/prune": {
"post": {
"tags": [
"Image"
],
"summary": "Delete builder cache",
"operationId": "BuildPrune",
"parameters": [
{
"name": "keep-storage",
"in": "query",
"description": "Amount of disk space in bytes to keep for cache",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "all",
"in": "query",
"description": "Remove all types of build cache",
"schema": {
"type": "boolean"
}
},
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the list of build cache objects.\n\nAvailable filters:\n\n- `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.\n- `id=<id>`\n- `parent=<id>`\n- `type=<string>`\n- `description=<string>`\n- `inuse`\n- `shared`\n- `private`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "BuildPruneResponse",
"type": "object",
"properties": {
"CachesDeleted": {
"type": "array",
"items": {
"type": "string",
"description": "ID of build cache object"
}
},
"SpaceReclaimed": {
"type": "integer",
"description": "Disk space reclaimed in bytes",
"format": "int64"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/create": {
"post": {
"tags": [
"Image"
],
"summary": "Create an image",
"description": "Create an image by either pulling it from a registry or importing it.",
"operationId": "ImageCreate",
"parameters": [
{
"name": "fromImage",
"in": "query",
"description": "Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed.",
"schema": {
"type": "string"
}
},
{
"name": "fromSrc",
"in": "query",
"description": "Source to import. The value may be a URL from which the image can be retrieved or `-` to read the image from the request body. This parameter may only be used when importing an image.",
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"description": "Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image.",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled.",
"schema": {
"type": "string"
}
},
{
"name": "message",
"in": "query",
"description": "Set commit message for imported image.",
"schema": {
"type": "string"
}
},
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"schema": {
"type": "string"
}
},
{
"name": "changes",
"in": "query",
"description": "Apply `Dockerfile` instructions to the image that is created,\nfor example: `changes=ENV DEBUG=true`.\nNote that `ENV DEBUG=true` should be URI component encoded.\n\nSupported `Dockerfile` instructions:\n`CMD`|`ENTRYPOINT`|`ENV`|`EXPOSE`|`ONBUILD`|`USER`|`VOLUME`|`WORKDIR`\n",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "platform",
"in": "query",
"description": "Platform in the format os[/arch[/variant]].\n\nWhen used in combination with the `fromImage` option, the daemon checks\nif the given image is present in the local image cache with the given\nOS and Architecture, and otherwise attempts to pull the image. If the\noption is not set, the host's native OS and Architecture are used.\nIf the given image does not exist in the local image cache, the daemon\nattempts to pull the image with the host's native OS and Architecture.\nIf the given image does exists in the local image cache, but its OS or\narchitecture does not match, a warning is produced.\n\nWhen used with the `fromSrc` option to import an image from an archive,\nthis option sets the platform information for the imported image. If\nthe option is not set, the host's native OS and Architecture are used\nfor the imported image.\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Image content if the value `-` has been specified in fromSrc query parameter",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/octet-stream": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "repository does not exist or no read access",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "inputImage"
}
},
"/images/{name}/json": {
"get": {
"tags": [
"Image"
],
"summary": "Inspect an image",
"description": "Return low-level information about an image.",
"operationId": "ImageInspect",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageInspect"
}
}
}
},
"404": {
"description": "No such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such image: someimage (tag: latest)"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/{name}/history": {
"get": {
"tags": [
"Image"
],
"summary": "Get the history of an image",
"description": "Return parent layers of an image.",
"operationId": "ImageHistory",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "List of image layers",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"title": "HistoryResponseItem",
"required": [
"Comment",
"Created",
"CreatedBy",
"Id",
"Size",
"Tags"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"nullable": false
},
"Created": {
"type": "integer",
"format": "int64",
"nullable": false
},
"CreatedBy": {
"type": "string",
"nullable": false
},
"Tags": {
"type": "array",
"items": {
"type": "string"
}
},
"Size": {
"type": "integer",
"format": "int64",
"nullable": false
},
"Comment": {
"type": "string",
"nullable": false
}
},
"description": "individual image layer information in response to ImageHistory operation",
"x-go-name": "HistoryResponseItem"
}
},
"example": [
{
"Id": "3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710",
"Created": 1398108230,
"CreatedBy": "/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /",
"Tags": [
"ubuntu:lucid",
"ubuntu:10.04"
],
"Size": 182964289,
"Comment": ""
},
{
"Id": "6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8",
"Created": 1398108222,
"CreatedBy": "/bin/sh -c #(nop) MAINTAINER Tianon Gravi <[email protected]> - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/",
"Tags": [],
"Size": 0,
"Comment": ""
},
{
"Id": "511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158",
"Created": 1371157430,
"CreatedBy": "",
"Tags": [
"scratch12:latest",
"scratch:latest"
],
"Size": 0,
"Comment": "Imported from -"
}
]
}
}
},
"404": {
"description": "No such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/{name}/push": {
"post": {
"tags": [
"Image"
],
"summary": "Push an image",
"description": "Push an image to a registry.\n\nIf you wish to push an image on to a private registry, that image must\nalready have a tag which references the registry. For example,\n`registry.example.com/myimage:latest`.\n\nThe push is cancelled if the HTTP connection is closed.\n",
"operationId": "ImagePush",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "The tag to associate with the image on the registry.",
"schema": {
"type": "string"
}
},
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {}
},
"404": {
"description": "No such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/{name}/tag": {
"post": {
"tags": [
"Image"
],
"summary": "Tag an image",
"description": "Tag an image so that it becomes part of a repository.",
"operationId": "ImageTag",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or ID to tag.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"description": "The repository to tag in. For example, `someuser/someimage`.",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "The name of the new tag.",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "No error",
"content": {}
},
"400": {
"description": "Bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "No such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/{name}": {
"delete": {
"tags": [
"Image"
],
"summary": "Remove an image",
"description": "Remove an image, along with any untagged parent images that were\nreferenced by that image.\n\nImages can't be removed if they have descendant images, are being\nused by a running container or are being used by a build.\n",
"operationId": "ImageDelete",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Remove the image even if it is being used by stopped containers or has other tags",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "noprune",
"in": "query",
"description": "Do not delete untagged parent images",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "The image was deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageDeleteResponseItem"
}
},
"example": [
{
"Untagged": "3e2f21a89f"
},
{
"Deleted": "3e2f21a89f"
},
{
"Deleted": "53b4f83ac9"
}
]
}
}
},
"404": {
"description": "No such image",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/search": {
"get": {
"tags": [
"Image"
],
"summary": "Search images",
"description": "Search for an image on Docker Hub.",
"operationId": "ImageSearch",
"parameters": [
{
"name": "term",
"in": "query",
"description": "Term to search",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of results to return",
"schema": {
"type": "integer"
}
},
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:\n\n- `is-automated=(true|false)`\n- `is-official=(true|false)`\n- `stars=<number>` Matches images that has at least 'number' stars.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"title": "ImageSearchResponseItem",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"is_official": {
"type": "boolean"
},
"is_automated": {
"type": "boolean"
},
"name": {
"type": "string"
},
"star_count": {
"type": "integer"
}
}
}
},
"example": [
{
"description": "",
"is_official": false,
"is_automated": false,
"name": "wma55/u1210sshd",
"star_count": 0
},
{
"description": "",
"is_official": false,
"is_automated": false,
"name": "jdswinbank/sshd",
"star_count": 0
},
{
"description": "",
"is_official": false,
"is_automated": false,
"name": "vgauthier/sshd",
"star_count": 0
}
]
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/prune": {
"post": {
"tags": [
"Image"
],
"summary": "Delete unused images",
"operationId": "ImagePrune",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "Filters to process on the prune list, encoded as JSON (a `map[string][]string`). Available filters:\n\n- `dangling=<boolean>` When set to `true` (or `1`), prune only\n unused *and* untagged images. When set to `false`\n (or `0`), all unused images are pruned.\n- `until=<string>` Prune images created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune images with (or without, in case `label!=...` is used) the specified labels.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "ImagePruneResponse",
"type": "object",
"properties": {
"ImagesDeleted": {
"type": "array",
"description": "Images that were deleted",
"items": {
"$ref": "#/components/schemas/ImageDeleteResponseItem"
}
},
"SpaceReclaimed": {
"type": "integer",
"description": "Disk space reclaimed in bytes",
"format": "int64"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/auth": {
"post": {
"tags": [
"System"
],
"summary": "Check auth configuration",
"description": "Validate credentials for a registry and, if available, get an identity\ntoken for accessing the registry without password.\n",
"operationId": "SystemAuth",
"requestBody": {
"description": "Authentication to check",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "An identity token was generated successfully.",
"content": {
"application/json": {
"schema": {
"title": "SystemAuthResponse",
"required": [
"Status"
],
"type": "object",
"properties": {
"Status": {
"type": "string",
"description": "The status of the authentication",
"nullable": false
},
"IdentityToken": {
"type": "string",
"description": "An opaque token used to authenticate a user after a successful login",
"nullable": false
}
}
},
"example": {
"Status": "Login Succeeded",
"IdentityToken": "9cbaf023786cd7..."
}
}
}
},
"204": {
"description": "No error",
"content": {}
},
"401": {
"description": "Auth error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "authConfig"
}
},
"/info": {
"get": {
"tags": [
"System"
],
"summary": "Get system information",
"operationId": "SystemInfo",
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemInfo"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/version": {
"get": {
"tags": [
"System"
],
"summary": "Get version",
"description": "Returns the version of Docker that is running and various information about the system that Docker is running on.",
"operationId": "SystemVersion",
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SystemVersion"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/_ping": {
"get": {
"tags": [
"System"
],
"summary": "Ping",
"description": "This is a dummy endpoint you can use to test if the server is accessible.",
"operationId": "SystemPing",
"responses": {
"200": {
"description": "no error",
"headers": {
"Swarm": {
"description": "Contains information about Swarm status of the daemon,\nand if the daemon is acting as a manager or worker node.\n",
"schema": {
"type": "string",
"default": "inactive",
"enum": [
"inactive",
"pending",
"error",
"locked",
"active/worker",
"active/manager"
]
}
},
"Docker-Experimental": {
"description": "If the server is running with experimental mode enabled",
"schema": {
"type": "boolean"
}
},
"Cache-Control": {
"schema": {
"type": "string",
"default": "no-cache, no-store, must-revalidate"
}
},
"Pragma": {
"schema": {
"type": "string",
"default": "no-cache"
}
},
"API-Version": {
"description": "Max API Version the server supports",
"schema": {
"type": "string"
}
},
"Builder-Version": {
"description": "Default version of docker image builder\n\nThe default on Linux is version \"2\" (BuildKit), but the daemon\ncan be configured to recommend version \"1\" (classic Builder).\nWindows does not yet support BuildKit for native Windows images,\nand uses \"1\" (classic builder) as a default.\n\nThis value is a recommendation as advertised by the daemon, and\nit is up to the client to choose which builder to use.\n",
"schema": {
"type": "string",
"default": "2"
}
}
},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "OK"
}
}
}
},
"500": {
"description": "server error",
"headers": {
"Cache-Control": {
"schema": {
"type": "string",
"default": "no-cache, no-store, must-revalidate"
}
},
"Pragma": {
"schema": {
"type": "string",
"default": "no-cache"
}
}
},
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"head": {
"tags": [
"System"
],
"summary": "Ping",
"description": "This is a dummy endpoint you can use to test if the server is accessible.",
"operationId": "SystemPingHead",
"responses": {
"200": {
"description": "no error",
"headers": {
"Swarm": {
"description": "Contains information about Swarm status of the daemon,\nand if the daemon is acting as a manager or worker node.\n",
"schema": {
"type": "string",
"default": "inactive",
"enum": [
"inactive",
"pending",
"error",
"locked",
"active/worker",
"active/manager"
]
}
},
"Docker-Experimental": {
"description": "If the server is running with experimental mode enabled",
"schema": {
"type": "boolean"
}
},
"Cache-Control": {
"schema": {
"type": "string",
"default": "no-cache, no-store, must-revalidate"
}
},
"Pragma": {
"schema": {
"type": "string",
"default": "no-cache"
}
},
"API-Version": {
"description": "Max API Version the server supports",
"schema": {
"type": "string"
}
},
"Builder-Version": {
"description": "Default version of docker image builder",
"schema": {
"type": "string"
}
}
},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "(empty)"
}
}
}
},
"500": {
"description": "server error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/commit": {
"post": {
"tags": [
"Image"
],
"summary": "Create a new image from a container",
"operationId": "ImageCommit",
"parameters": [
{
"name": "container",
"in": "query",
"description": "The ID or name of the container to commit",
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"description": "Repository name for the created image",
"schema": {
"type": "string"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag name for the create image",
"schema": {
"type": "string"
}
},
{
"name": "comment",
"in": "query",
"description": "Commit message",
"schema": {
"type": "string"
}
},
{
"name": "author",
"in": "query",
"description": "Author of the image (e.g., `John Hannibal Smith <[email protected]>`)",
"schema": {
"type": "string"
}
},
{
"name": "pause",
"in": "query",
"description": "Whether to pause the container before committing",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "changes",
"in": "query",
"description": "`Dockerfile` instructions to apply while committing",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The container configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContainerConfig"
}
}
},
"required": false
},
"responses": {
"201": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "containerConfig"
}
},
"/events": {
"get": {
"tags": [
"System"
],
"summary": "Monitor events",
"description": "Stream real-time events from the server.\n\nVarious objects within Docker report events when something happens to them.\n\nContainers report these events: `attach`, `commit`, `copy`, `create`, `destroy`, `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`, `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`, `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`\n\nImages report these events: `delete`, `import`, `load`, `pull`, `push`, `save`, `tag`, `untag`, and `prune`\n\nVolumes report these events: `create`, `mount`, `unmount`, `destroy`, and `prune`\n\nNetworks report these events: `create`, `connect`, `disconnect`, `destroy`, `update`, `remove`, and `prune`\n\nThe Docker daemon reports these events: `reload`\n\nServices report these events: `create`, `update`, and `remove`\n\nNodes report these events: `create`, `update`, and `remove`\n\nSecrets report these events: `create`, `update`, and `remove`\n\nConfigs report these events: `create`, `update`, and `remove`\n\nThe Builder reports `prune` events\n",
"operationId": "SystemEvents",
"parameters": [
{
"name": "since",
"in": "query",
"description": "Show events created since this timestamp then stream new events.",
"schema": {
"type": "string"
}
},
{
"name": "until",
"in": "query",
"description": "Show events created until this timestamp then stop streaming.",
"schema": {
"type": "string"
}
},
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of filters (a `map[string][]string`) to process on the event list. Available filters:\n\n- `config=<string>` config name or ID\n- `container=<string>` container name or ID\n- `daemon=<string>` daemon name or ID\n- `event=<string>` event type\n- `image=<string>` image name or ID\n- `label=<string>` image or container label\n- `network=<string>` network name or ID\n- `node=<string>` node ID\n- `plugin`=<string> plugin name or ID\n- `scope`=<string> local or swarm\n- `secret=<string>` secret name or ID\n- `service=<string>` service name or ID\n- `type=<string>` object to filter by, one of `container`, `image`, `volume`, `network`, `daemon`, `plugin`, `node`, `service`, `secret` or `config`\n- `volume=<string>` volume name\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventMessage"
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/system/df": {
"get": {
"tags": [
"System"
],
"summary": "Get data usage information",
"operationId": "SystemDataUsage",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Object types, for which to compute and return data.\n",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"container",
"image",
"volume",
"build-cache"
]
}
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"title": "SystemDataUsageResponse",
"type": "object",
"properties": {
"LayersSize": {
"type": "integer",
"format": "int64"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageSummary"
}
},
"Containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContainerSummary"
}
},
"Volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"BuildCache": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildCache"
}
}
},
"example": {
"LayersSize": 1092588,
"Images": [
{
"Id": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
"ParentId": "",
"RepoTags": [
"busybox:latest"
],
"RepoDigests": [
"busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
],
"Created": 1466724217,
"Size": 1092588,
"SharedSize": 0,
"VirtualSize": 1092588,
"Labels": {},
"Containers": 1
}
],
"Containers": [
{
"Id": "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148",
"Names": [
"/top"
],
"Image": "busybox",
"ImageID": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
"Command": "top",
"Created": 1472592424,
"Ports": [],
"SizeRootFs": 1092588,
"Labels": {},
"State": "exited",
"Status": "Exited (0) 56 minutes ago",
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92",
"EndpointID": "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a",
"Gateway": "172.18.0.1",
"IPAddress": "172.18.0.2",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:12:00:02"
}
}
},
"Mounts": []
}
],
"Volumes": [
{
"Name": "my-volume",
"Driver": "local",
"Mountpoint": "/var/lib/docker/volumes/my-volume/_data",
"Scope": "local",
"UsageData": {
"Size": 10920104,
"RefCount": 2
}
}
],
"BuildCache": [
{
"ID": "hw53o5aio51xtltp5xjp8v7fx",
"Parents": [],
"Type": "regular",
"Description": "pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0",
"InUse": false,
"Shared": true,
"Size": 0,
"CreatedAt": "2021-06-28T13:31:01.474619385Z",
"LastUsedAt": "2021-07-07T22:02:32.738075951Z",
"UsageCount": 26
},
{
"ID": "ndlpt0hhvkqcdfkputsk4cq9c",
"Parents": [
"ndlpt0hhvkqcdfkputsk4cq9c"
],
"Type": "regular",
"Description": "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache",
"InUse": false,
"Shared": true,
"Size": 51,
"CreatedAt": "2021-06-28T13:31:03.002625487Z",
"LastUsedAt": "2021-07-07T22:02:32.773909517Z",
"UsageCount": 26
}
]
}
}
},
"text/plain": {
"schema": {
"title": "SystemDataUsageResponse",
"type": "object",
"properties": {
"LayersSize": {
"type": "integer",
"format": "int64"
},
"Images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageSummary"
}
},
"Containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContainerSummary"
}
},
"Volumes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"BuildCache": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BuildCache"
}
}
},
"example": {
"LayersSize": 1092588,
"Images": [
{
"Id": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
"ParentId": "",
"RepoTags": [
"busybox:latest"
],
"RepoDigests": [
"busybox@sha256:a59906e33509d14c036c8678d687bd4eec81ed7c4b8ce907b888c607f6a1e0e6"
],
"Created": 1466724217,
"Size": 1092588,
"SharedSize": 0,
"VirtualSize": 1092588,
"Labels": {},
"Containers": 1
}
],
"Containers": [
{
"Id": "e575172ed11dc01bfce087fb27bee502db149e1a0fad7c296ad300bbff178148",
"Names": [
"/top"
],
"Image": "busybox",
"ImageID": "sha256:2b8fd9751c4c0f5dd266fcae00707e67a2545ef34f9a29354585f93dac906749",
"Command": "top",
"Created": 1472592424,
"Ports": [],
"SizeRootFs": 1092588,
"Labels": {},
"State": "exited",
"Status": "Exited (0) 56 minutes ago",
"HostConfig": {
"NetworkMode": "default"
},
"NetworkSettings": {
"Networks": {
"bridge": {
"NetworkID": "d687bc59335f0e5c9ee8193e5612e8aee000c8c62ea170cfb99c098f95899d92",
"EndpointID": "8ed5115aeaad9abb174f68dcf135b49f11daf597678315231a32ca28441dec6a",
"Gateway": "172.18.0.1",
"IPAddress": "172.18.0.2",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:12:00:02"
}
}
},
"Mounts": []
}
],
"Volumes": [
{
"Name": "my-volume",
"Driver": "local",
"Mountpoint": "/var/lib/docker/volumes/my-volume/_data",
"Scope": "local",
"UsageData": {
"Size": 10920104,
"RefCount": 2
}
}
],
"BuildCache": [
{
"ID": "hw53o5aio51xtltp5xjp8v7fx",
"Parents": [],
"Type": "regular",
"Description": "pulled from docker.io/library/debian@sha256:234cb88d3020898631af0ccbbcca9a66ae7306ecd30c9720690858c1b007d2a0",
"InUse": false,
"Shared": true,
"Size": 0,
"CreatedAt": "2021-06-28T13:31:01.474619385Z",
"LastUsedAt": "2021-07-07T22:02:32.738075951Z",
"UsageCount": 26
},
{
"ID": "ndlpt0hhvkqcdfkputsk4cq9c",
"Parents": [
"ndlpt0hhvkqcdfkputsk4cq9c"
],
"Type": "regular",
"Description": "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache",
"InUse": false,
"Shared": true,
"Size": 51,
"CreatedAt": "2021-06-28T13:31:03.002625487Z",
"LastUsedAt": "2021-07-07T22:02:32.773909517Z",
"UsageCount": 26
}
]
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/{name}/get": {
"get": {
"tags": [
"Image"
],
"summary": "Export an image",
"description": "Get a tarball containing all images and metadata for a repository.\n\nIf `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.\n\n### Image tarball format\n\nAn image tarball contains one directory per image layer (named using its long ID), each containing these files:\n\n- `VERSION`: currently `1.0` - the file format version\n- `json`: detailed layer information, similar to `docker inspect layer_id`\n- `layer.tar`: A tarfile containing the filesystem changes in this layer\n\nThe `layer.tar` file contains `aufs` style `.wh..wh.aufs` files and directories for storing attribute changes and deletions.\n\nIf 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.\n\n```json\n{\n \"hello-world\": {\n \"latest\": \"565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1\"\n }\n}\n```\n",
"operationId": "ImageGet",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/x-tar": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/x-tar": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/get": {
"get": {
"tags": [
"Image"
],
"summary": "Export several images",
"description": "Get a tarball containing all images and metadata for several image\nrepositories.\n\nFor each value of the `names` parameter: if it is a specific name and\ntag (e.g. `ubuntu:latest`), then only that image (and its parents) are\nreturned; if it is an image ID, similarly only that image (and its parents)\nare returned and there would be no names referenced in the 'repositories'\nfile for this image ID.\n\nFor details on the format, see the [export image endpoint](#operation/ImageGet).\n",
"operationId": "ImageGetAll",
"parameters": [
{
"name": "names",
"in": "query",
"description": "Image names to filter by",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/x-tar": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/x-tar": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/images/load": {
"post": {
"tags": [
"Image"
],
"summary": "Import images",
"description": "Load a set of images and tags into a repository.\n\nFor details on the format, see the [export image endpoint](#operation/ImageGet).\n",
"operationId": "ImageLoad",
"parameters": [
{
"name": "quiet",
"in": "query",
"description": "Suppress progress details during load.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "Tar archive containing images",
"content": {
"application/x-tar": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "imagesTarball"
}
},
"/containers/{id}/exec": {
"post": {
"tags": [
"Exec"
],
"summary": "Create an exec instance",
"description": "Run a command inside a running container.",
"operationId": "ContainerExec",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of container",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Exec configuration",
"content": {
"application/json": {
"schema": {
"title": "ExecConfig",
"type": "object",
"properties": {
"AttachStdin": {
"type": "boolean",
"description": "Attach to `stdin` of the exec command."
},
"AttachStdout": {
"type": "boolean",
"description": "Attach to `stdout` of the exec command."
},
"AttachStderr": {
"type": "boolean",
"description": "Attach to `stderr` of the exec command."
},
"ConsoleSize": {
"maxItems": 2,
"minItems": 2,
"type": "array",
"description": "Initial console size, as an `[height, width]` array.",
"nullable": true,
"items": {
"minimum": 0,
"type": "integer"
}
},
"DetachKeys": {
"type": "string",
"description": "Override the key sequence for detaching a container. Format is\na single character `[a-Z]` or `ctrl-<value>` where `<value>`\nis one of: `a-z`, `@`, `^`, `[`, `,` or `_`.\n"
},
"Tty": {
"type": "boolean",
"description": "Allocate a pseudo-TTY."
},
"Env": {
"type": "array",
"description": "A list of environment variables in the form `[\"VAR=value\", ...]`.\n",
"items": {
"type": "string"
}
},
"Cmd": {
"type": "array",
"description": "Command to run, as a string or array of strings.",
"items": {
"type": "string"
}
},
"Privileged": {
"type": "boolean",
"description": "Runs the exec process with extended privileges.",
"default": false
},
"User": {
"type": "string",
"description": "The user, and optionally, group to run the exec process inside\nthe container. Format is one of: `user`, `user:group`, `uid`,\nor `uid:gid`.\n"
},
"WorkingDir": {
"type": "string",
"description": "The working directory for the exec process inside the container.\n"
}
},
"example": {
"AttachStdin": false,
"AttachStdout": true,
"AttachStderr": true,
"DetachKeys": "ctrl-p,ctrl-q",
"Tty": false,
"Cmd": [
"date"
],
"Env": [
"FOO=bar",
"BAZ=quux"
]
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"404": {
"description": "no such container",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such container: c2ada9df5af8"
}
}
}
},
"409": {
"description": "container is paused",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "execConfig"
}
},
"/exec/{id}/start": {
"post": {
"tags": [
"Exec"
],
"summary": "Start an exec instance",
"description": "Starts a previously set up exec instance. If detach is true, this endpoint\nreturns immediately after starting the command. Otherwise, it sets up an\ninteractive session with the command.\n",
"operationId": "ExecStart",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Exec instance ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "ExecStartConfig",
"type": "object",
"properties": {
"Detach": {
"type": "boolean",
"description": "Detach from the command."
},
"Tty": {
"type": "boolean",
"description": "Allocate a pseudo-TTY."
},
"ConsoleSize": {
"maxItems": 2,
"minItems": 2,
"type": "array",
"description": "Initial console size, as an `[height, width]` array.",
"nullable": true,
"items": {
"minimum": 0,
"type": "integer"
}
}
},
"example": {
"Detach": false,
"Tty": true,
"ConsoleSize": [
80,
64
]
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "No error",
"content": {}
},
"404": {
"description": "No such exec instance",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Container is stopped or paused",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "execStartConfig"
}
},
"/exec/{id}/resize": {
"post": {
"tags": [
"Exec"
],
"summary": "Resize an exec instance",
"description": "Resize the TTY session used by an exec instance. This endpoint only works\nif `tty` was specified as part of creating and starting the exec instance.\n",
"operationId": "ExecResize",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Exec instance ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "h",
"in": "query",
"description": "Height of the TTY session in characters",
"schema": {
"type": "integer"
}
},
{
"name": "w",
"in": "query",
"description": "Width of the TTY session in characters",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "No such exec instance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/exec/{id}/json": {
"get": {
"tags": [
"Exec"
],
"summary": "Inspect an exec instance",
"description": "Return low-level information about an exec instance.",
"operationId": "ExecInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Exec instance ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "ExecInspectResponse",
"type": "object",
"properties": {
"CanRemove": {
"type": "boolean"
},
"DetachKeys": {
"type": "string"
},
"ID": {
"type": "string"
},
"Running": {
"type": "boolean"
},
"ExitCode": {
"type": "integer"
},
"ProcessConfig": {
"$ref": "#/components/schemas/ProcessConfig"
},
"OpenStdin": {
"type": "boolean"
},
"OpenStderr": {
"type": "boolean"
},
"OpenStdout": {
"type": "boolean"
},
"ContainerID": {
"type": "string"
},
"Pid": {
"type": "integer",
"description": "The system process ID for the exec process."
}
}
},
"example": {
"CanRemove": false,
"ContainerID": "b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126",
"DetachKeys": "",
"ExitCode": 2,
"ID": "f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b",
"OpenStderr": true,
"OpenStdin": true,
"OpenStdout": true,
"ProcessConfig": {
"arguments": [
"-c",
"exit 2"
],
"entrypoint": "sh",
"privileged": false,
"tty": true,
"user": "1000"
},
"Running": false,
"Pid": 42000
}
}
}
},
"404": {
"description": "No such exec instance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/volumes": {
"get": {
"tags": [
"Volume"
],
"summary": "List volumes",
"operationId": "VolumeList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the volumes list. Available filters:\n\n- `dangling=<boolean>` When set to `true` (or `1`), returns all\n volumes that are not in use by a container. When set to `false`\n (or `0`), only volumes that are in use by one or more\n containers are returned.\n- `driver=<volume-driver-name>` Matches volumes based on their driver.\n- `label=<key>` or `label=<key>:<value>` Matches volumes based on\n the presence of a `label` alone or a `label` and a value.\n- `name=<volume-name>` Matches all or part of a volume name.\n",
"schema": {
"type": "string",
"format": "json"
}
}
],
"responses": {
"200": {
"description": "Summary volume data that matches the query",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolumeListResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/volumes/create": {
"post": {
"tags": [
"Volume"
],
"summary": "Create a volume",
"operationId": "VolumeCreate",
"requestBody": {
"description": "Volume configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VolumeCreateOptions"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The volume was created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Volume"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "volumeConfig"
}
},
"/volumes/{name}": {
"get": {
"tags": [
"Volume"
],
"summary": "Inspect a volume",
"operationId": "VolumeInspect",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Volume name or ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Volume"
}
}
}
},
"404": {
"description": "No such volume",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Volume"
],
"summary": "\"Update a volume. Valid only for Swarm cluster volumes\"\n",
"operationId": "VolumeUpdate",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name or ID of the volume",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "The version number of the volume being updated. This is required to\navoid conflicting writes. Found in the volume's `ClusterVolume`\nfield.\n",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The spec of the volume to update. Currently, only Availability may\nchange. All other fields must remain unchanged.\n",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Spec": {
"$ref": "#/components/schemas/ClusterVolumeSpec"
}
},
"description": "Volume configuration"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such volume",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Volume"
],
"summary": "Remove a volume",
"description": "Instruct the driver to remove the volume.",
"operationId": "VolumeDelete",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Volume name or ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force the removal of the volume",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"204": {
"description": "The volume was removed",
"content": {}
},
"404": {
"description": "No such volume or volume driver",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "Volume is in use and cannot be removed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/volumes/prune": {
"post": {
"tags": [
"Volume"
],
"summary": "Delete unused volumes",
"operationId": "VolumePrune",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\nAvailable filters:\n- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune volumes with (or without, in case `label!=...` is used) the specified labels.\n- `all` (`all=true`) - Consider all (local) volumes for pruning and not just anonymous volumes.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "VolumePruneResponse",
"type": "object",
"properties": {
"VolumesDeleted": {
"type": "array",
"description": "Volumes that were deleted",
"items": {
"type": "string"
}
},
"SpaceReclaimed": {
"type": "integer",
"description": "Disk space reclaimed in bytes",
"format": "int64"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/networks": {
"get": {
"tags": [
"Network"
],
"summary": "List networks",
"description": "Returns a list of networks. For details on the format, see the\n[network inspect endpoint](#operation/NetworkInspect).\n\nNote that it uses a different, smaller representation of a network than\ninspecting a single network. For example, the list of containers attached\nto the network is not propagated in API versions 1.28 and up.\n",
"operationId": "NetworkList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "JSON encoded value of the filters (a `map[string][]string`) to process\non the networks list.\n\nAvailable filters:\n\n- `dangling=<boolean>` When set to `true` (or `1`), returns all\n networks that are not in use by a container. When set to `false`\n (or `0`), only networks that are in use by one or more\n containers are returned.\n- `driver=<driver-name>` Matches a network's driver.\n- `id=<network-id>` Matches all or part of a network ID.\n- `label=<key>` or `label=<key>=<value>` of a network label.\n- `name=<network-name>` Matches all or part of a network name.\n- `scope=[\"swarm\"|\"global\"|\"local\"]` Filters networks by scope (`swarm`, `global`, or `local`).\n- `type=[\"custom\"|\"builtin\"]` Filters networks by type. The `custom` keyword returns all user-defined networks.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Network"
}
},
"example": [
{
"Name": "bridge",
"Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
"Created": "2016-10-19T06:21:00.416543526Z",
"Scope": "local",
"Driver": "bridge",
"EnableIPv6": false,
"Internal": false,
"Attachable": false,
"Ingress": false,
"IPAM": {
"Driver": "default",
"Config": [
{
"Subnet": "172.17.0.0/16"
}
]
},
"Options": {
"com.docker.network.bridge.default_bridge": "true",
"com.docker.network.bridge.enable_icc": "true",
"com.docker.network.bridge.enable_ip_masquerade": "true",
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
"com.docker.network.bridge.name": "docker0",
"com.docker.network.driver.mtu": "1500"
}
},
{
"Name": "none",
"Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
"Created": "0001-01-01T00:00:00Z",
"Scope": "local",
"Driver": "null",
"EnableIPv6": false,
"Internal": false,
"Attachable": false,
"Ingress": false,
"IPAM": {
"Driver": "default",
"Config": []
},
"Containers": {},
"Options": {}
},
{
"Name": "host",
"Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
"Created": "0001-01-01T00:00:00Z",
"Scope": "local",
"Driver": "host",
"EnableIPv6": false,
"Internal": false,
"Attachable": false,
"Ingress": false,
"IPAM": {
"Driver": "default",
"Config": []
},
"Containers": {},
"Options": {}
}
]
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/networks/{id}": {
"get": {
"tags": [
"Network"
],
"summary": "Inspect a network",
"operationId": "NetworkInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Network ID or name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "verbose",
"in": "query",
"description": "Detailed inspect output for troubleshooting",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "scope",
"in": "query",
"description": "Filter the network by scope (swarm, global, or local)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Network"
}
}
}
},
"404": {
"description": "Network not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Network"
],
"summary": "Remove a network",
"operationId": "NetworkDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Network ID or name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No error",
"content": {}
},
"403": {
"description": "operation not supported for pre-defined networks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such network",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/networks/create": {
"post": {
"tags": [
"Network"
],
"summary": "Create a network",
"operationId": "NetworkCreate",
"requestBody": {
"description": "Network configuration",
"content": {
"application/json": {
"schema": {
"title": "NetworkCreateRequest",
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The network's name."
},
"CheckDuplicate": {
"type": "boolean",
"description": "Check for networks with duplicate names. Since Network is\nprimarily keyed based on a random ID and not on the name, and\nnetwork name is strictly a user-friendly alias to the network\nwhich is uniquely identified using ID, there is no guaranteed\nway to check for duplicates. CheckDuplicate is there to provide\na best effort checking of any networks which has the same name\nbut it is not guaranteed to catch all name collisions.\n"
},
"Driver": {
"type": "string",
"description": "Name of the network driver plugin to use.",
"default": "bridge"
},
"Internal": {
"type": "boolean",
"description": "Restrict external access to the network."
},
"Attachable": {
"type": "boolean",
"description": "Globally scoped network is manually attachable by regular\ncontainers from workers in swarm mode.\n"
},
"Ingress": {
"type": "boolean",
"description": "Ingress network is the network which provides the routing-mesh\nin swarm mode.\n"
},
"IPAM": {
"$ref": "#/components/schemas/IPAM"
},
"EnableIPv6": {
"type": "boolean",
"description": "Enable IPv6 on the network."
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Network specific options to be used by the drivers."
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
}
},
"example": {
"Name": "isolated_nw",
"CheckDuplicate": false,
"Driver": "bridge",
"EnableIPv6": true,
"IPAM": {
"Driver": "default",
"Config": [
{
"Subnet": "172.20.0.0/16",
"IPRange": "172.20.10.0/24",
"Gateway": "172.20.10.11"
},
{
"Subnet": "2001:db8:abcd::/64",
"Gateway": "2001:db8:abcd::1011"
}
],
"Options": {
"foo": "bar"
}
},
"Internal": true,
"Attachable": false,
"Ingress": false,
"Options": {
"com.docker.network.bridge.default_bridge": "true",
"com.docker.network.bridge.enable_icc": "true",
"com.docker.network.bridge.enable_ip_masquerade": "true",
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
"com.docker.network.bridge.name": "docker0",
"com.docker.network.driver.mtu": "1500"
},
"Labels": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "NetworkCreateResponse",
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of the created network."
},
"Warning": {
"type": "string"
}
},
"example": {
"Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
"Warning": ""
}
}
}
}
},
"403": {
"description": "operation not supported for pre-defined networks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "plugin not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "networkConfig"
}
},
"/networks/{id}/connect": {
"post": {
"tags": [
"Network"
],
"summary": "Connect a container to a network",
"operationId": "NetworkConnect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Network ID or name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "NetworkConnectRequest",
"type": "object",
"properties": {
"Container": {
"type": "string",
"description": "The ID or name of the container to connect to the network."
},
"EndpointConfig": {
"$ref": "#/components/schemas/EndpointSettings"
}
},
"example": {
"Container": "3613f73ba0e4",
"EndpointConfig": {
"IPAMConfig": {
"IPv4Address": "172.24.56.89",
"IPv6Address": "2001:db8::5689"
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No error",
"content": {}
},
"403": {
"description": "Operation not supported for swarm scoped networks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Network or container not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "container"
}
},
"/networks/{id}/disconnect": {
"post": {
"tags": [
"Network"
],
"summary": "Disconnect a container from a network",
"operationId": "NetworkDisconnect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Network ID or name",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "NetworkDisconnectRequest",
"type": "object",
"properties": {
"Container": {
"type": "string",
"description": "The ID or name of the container to disconnect from the network.\n"
},
"Force": {
"type": "boolean",
"description": "Force the container to disconnect from the network.\n"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No error",
"content": {}
},
"403": {
"description": "Operation not supported for swarm scoped networks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Network or container not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "container"
}
},
"/networks/prune": {
"post": {
"tags": [
"Network"
],
"summary": "Delete unused networks",
"operationId": "NetworkPrune",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "Filters to process on the prune list, encoded as JSON (a `map[string][]string`).\n\nAvailable filters:\n- `until=<timestamp>` Prune networks created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.\n- `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...` is used) the specified labels.\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"title": "NetworkPruneResponse",
"type": "object",
"properties": {
"NetworksDeleted": {
"type": "array",
"description": "Networks that were deleted",
"items": {
"type": "string"
}
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins": {
"get": {
"tags": [
"Plugin"
],
"summary": "List plugins",
"description": "Returns information about installed plugins.",
"operationId": "PluginList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the plugin list.\n\nAvailable filters:\n\n- `capability=<capability name>`\n- `enable=<true>|<false>`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plugin"
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/privileges": {
"get": {
"tags": [
"Plugin"
],
"summary": "Get plugin privileges",
"operationId": "GetPluginPrivileges",
"parameters": [
{
"name": "remote",
"in": "query",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
},
"text/plain": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/pull": {
"post": {
"tags": [
"Plugin"
],
"summary": "Install a plugin",
"description": "Pulls and installs a plugin. After the plugin is installed, it can be\nenabled using the [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).\n",
"operationId": "PluginPull",
"parameters": [
{
"name": "remote",
"in": "query",
"description": "Remote reference for plugin to install.\n\nThe `:latest` tag is optional, and is used as the default if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Local name for the pulled plugin.\n\nThe `:latest` tag is optional, and is used as the default if omitted.\n",
"schema": {
"type": "string"
}
},
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration to use when pulling a plugin\nfrom a registry.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
},
"text/plain": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
}
},
"required": false
},
"responses": {
"204": {
"description": "no error",
"content": {}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/plugins/{name}/json": {
"get": {
"tags": [
"Plugin"
],
"summary": "Inspect a plugin",
"operationId": "PluginInspect",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plugin"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Plugin"
}
}
}
},
"404": {
"description": "plugin is not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/{name}": {
"delete": {
"tags": [
"Plugin"
],
"summary": "Remove a plugin",
"operationId": "PluginDelete",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Disable the plugin before removing. This may result in issues if the\nplugin is in use by a container.\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plugin"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Plugin"
}
}
}
},
"404": {
"description": "plugin is not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/{name}/enable": {
"post": {
"tags": [
"Plugin"
],
"summary": "Enable a plugin",
"operationId": "PluginEnable",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timeout",
"in": "query",
"description": "Set the HTTP client timeout (in seconds)",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "plugin is not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/{name}/disable": {
"post": {
"tags": [
"Plugin"
],
"summary": "Disable a plugin",
"operationId": "PluginDisable",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force disable a plugin even if still in use.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "plugin is not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/{name}/upgrade": {
"post": {
"tags": [
"Plugin"
],
"summary": "Upgrade a plugin",
"operationId": "PluginUpgrade",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "remote",
"in": "query",
"description": "Remote reference to upgrade to.\n\nThe `:latest` tag is optional, and is used as the default if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration to use when pulling a plugin\nfrom a registry.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
},
"text/plain": {
"schema": {
"type": "array",
"example": [
{
"Name": "network",
"Description": "",
"Value": [
"host"
]
},
{
"Name": "mount",
"Description": "",
"Value": [
"/data"
]
},
{
"Name": "device",
"Description": "",
"Value": [
"/dev/cpu_dma_latency"
]
}
],
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
}
},
"required": false
},
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "plugin not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/plugins/create": {
"post": {
"tags": [
"Plugin"
],
"summary": "Create a plugin",
"operationId": "PluginCreate",
"parameters": [
{
"name": "name",
"in": "query",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Path to tar containing plugin rootfs and manifest",
"content": {
"application/x-tar": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"required": false
},
"responses": {
"204": {
"description": "no error",
"content": {}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "tarContext"
}
},
"/plugins/{name}/push": {
"post": {
"tags": [
"Plugin"
],
"summary": "Push a plugin",
"description": "Push a plugin to the registry.\n",
"operationId": "PluginPush",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "plugin not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/plugins/{name}/set": {
"post": {
"tags": [
"Plugin"
],
"summary": "Configure a plugin",
"operationId": "PluginSet",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The name of the plugin. The `:latest` tag is optional, and is the\ndefault if omitted.\n",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
"DEBUG=1"
],
"items": {
"type": "string"
}
}
}
},
"required": false
},
"responses": {
"204": {
"description": "No error",
"content": {}
},
"404": {
"description": "Plugin not installed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/nodes": {
"get": {
"tags": [
"Node"
],
"summary": "List nodes",
"operationId": "NodeList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).\n\nAvailable filters:\n- `id=<node id>`\n- `label=<engine label>`\n- `membership=`(`accepted`|`pending`)`\n- `name=<node name>`\n- `node.label=<node label>`\n- `role=`(`manager`|`worker`)`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Node"
}
}
},
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Node"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/nodes/{id}": {
"get": {
"tags": [
"Node"
],
"summary": "Inspect a node",
"operationId": "NodeInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID or name of the node",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Node"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Node"
}
}
}
},
"404": {
"description": "no such node",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Node"
],
"summary": "Delete a node",
"operationId": "NodeDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID or name of the node",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "force",
"in": "query",
"description": "Force remove a node from the swarm",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such node",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/nodes/{id}/update": {
"post": {
"tags": [
"Node"
],
"summary": "Update a node",
"operationId": "NodeUpdate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the node",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "The version number of the node object being updated. This is required\nto avoid conflicting writes.\n",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeSpec"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NodeSpec"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such node",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/swarm": {
"get": {
"tags": [
"Swarm"
],
"summary": "Inspect swarm",
"operationId": "SwarmInspect",
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Swarm"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Swarm"
}
}
}
},
"404": {
"description": "no such swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/swarm/init": {
"post": {
"tags": [
"Swarm"
],
"summary": "Initialize a new swarm",
"operationId": "SwarmInit",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "SwarmInitRequest",
"type": "object",
"properties": {
"ListenAddr": {
"type": "string",
"description": "Listen address used for inter-manager communication, as well\nas determining the networking interface used for the VXLAN\nTunnel Endpoint (VTEP). This can either be an address/port\ncombination in the form `192.168.1.1:4567`, or an interface\nfollowed by a port number, like `eth0:4567`. If the port number\nis omitted, the default swarm listening port is used.\n"
},
"AdvertiseAddr": {
"type": "string",
"description": "Externally reachable address advertised to other nodes. This\ncan either be an address/port combination in the form\n`192.168.1.1:4567`, or an interface followed by a port number,\nlike `eth0:4567`. If the port number is omitted, the port\nnumber from the listen address is used. If `AdvertiseAddr` is\nnot specified, it will be automatically detected when possible.\n"
},
"DataPathAddr": {
"type": "string",
"description": "Address or interface to use for data path traffic (format:\n`<ip|interface>`), for example, `192.168.1.1`, or an interface,\nlike `eth0`. If `DataPathAddr` is unspecified, the same address\nas `AdvertiseAddr` is used.\n\nThe `DataPathAddr` specifies the address that global scope\nnetwork drivers will publish towards other nodes in order to\nreach the containers running on this node. Using this parameter\nit is possible to separate the container data traffic from the\nmanagement traffic of the cluster.\n"
},
"DataPathPort": {
"type": "integer",
"description": "DataPathPort specifies the data path port number for data traffic.\nAcceptable port range is 1024 to 49151.\nif no port is set or is set to 0, default port 4789 will be used.\n",
"format": "uint32"
},
"DefaultAddrPool": {
"type": "array",
"description": "Default Address Pool specifies default subnet pools for global\nscope networks.\n",
"items": {
"type": "string",
"example": ""
}
},
"ForceNewCluster": {
"type": "boolean",
"description": "Force creation of a new swarm."
},
"SubnetSize": {
"type": "integer",
"description": "SubnetSize specifies the subnet size of the networks created\nfrom the default subnet pool.\n",
"format": "uint32"
},
"Spec": {
"$ref": "#/components/schemas/SwarmSpec"
}
},
"example": {
"ListenAddr": "0.0.0.0:2377",
"AdvertiseAddr": "192.168.1.1:2377",
"DataPathPort": 4789,
"DefaultAddrPool": [
"10.10.0.0/8",
"20.20.0.0/8"
],
"SubnetSize": 24,
"ForceNewCluster": false,
"Spec": {
"Orchestration": {},
"Raft": {},
"Dispatcher": {},
"CAConfig": {},
"EncryptionConfig": {
"AutoLockManagers": false
}
}
}
}
},
"text/plain": {
"schema": {
"title": "SwarmInitRequest",
"type": "object",
"properties": {
"ListenAddr": {
"type": "string",
"description": "Listen address used for inter-manager communication, as well\nas determining the networking interface used for the VXLAN\nTunnel Endpoint (VTEP). This can either be an address/port\ncombination in the form `192.168.1.1:4567`, or an interface\nfollowed by a port number, like `eth0:4567`. If the port number\nis omitted, the default swarm listening port is used.\n"
},
"AdvertiseAddr": {
"type": "string",
"description": "Externally reachable address advertised to other nodes. This\ncan either be an address/port combination in the form\n`192.168.1.1:4567`, or an interface followed by a port number,\nlike `eth0:4567`. If the port number is omitted, the port\nnumber from the listen address is used. If `AdvertiseAddr` is\nnot specified, it will be automatically detected when possible.\n"
},
"DataPathAddr": {
"type": "string",
"description": "Address or interface to use for data path traffic (format:\n`<ip|interface>`), for example, `192.168.1.1`, or an interface,\nlike `eth0`. If `DataPathAddr` is unspecified, the same address\nas `AdvertiseAddr` is used.\n\nThe `DataPathAddr` specifies the address that global scope\nnetwork drivers will publish towards other nodes in order to\nreach the containers running on this node. Using this parameter\nit is possible to separate the container data traffic from the\nmanagement traffic of the cluster.\n"
},
"DataPathPort": {
"type": "integer",
"description": "DataPathPort specifies the data path port number for data traffic.\nAcceptable port range is 1024 to 49151.\nif no port is set or is set to 0, default port 4789 will be used.\n",
"format": "uint32"
},
"DefaultAddrPool": {
"type": "array",
"description": "Default Address Pool specifies default subnet pools for global\nscope networks.\n",
"items": {
"type": "string",
"example": ""
}
},
"ForceNewCluster": {
"type": "boolean",
"description": "Force creation of a new swarm."
},
"SubnetSize": {
"type": "integer",
"description": "SubnetSize specifies the subnet size of the networks created\nfrom the default subnet pool.\n",
"format": "uint32"
},
"Spec": {
"$ref": "#/components/schemas/SwarmSpec"
}
},
"example": {
"ListenAddr": "0.0.0.0:2377",
"AdvertiseAddr": "192.168.1.1:2377",
"DataPathPort": 4789,
"DefaultAddrPool": [
"10.10.0.0/8",
"20.20.0.0/8"
],
"SubnetSize": 24,
"ForceNewCluster": false,
"Spec": {
"Orchestration": {},
"Raft": {},
"Dispatcher": {},
"CAConfig": {},
"EncryptionConfig": {
"AutoLockManagers": false
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "The node ID",
"example": "7v2t30z9blmxuhnyo6s4cpenp"
}
},
"text/plain": {
"schema": {
"type": "string",
"description": "The node ID",
"example": "7v2t30z9blmxuhnyo6s4cpenp"
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is already part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/swarm/join": {
"post": {
"tags": [
"Swarm"
],
"summary": "Join an existing swarm",
"operationId": "SwarmJoin",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "SwarmJoinRequest",
"type": "object",
"properties": {
"ListenAddr": {
"type": "string",
"description": "Listen address used for inter-manager communication if the node\ngets promoted to manager, as well as determining the networking\ninterface used for the VXLAN Tunnel Endpoint (VTEP).\n"
},
"AdvertiseAddr": {
"type": "string",
"description": "Externally reachable address advertised to other nodes. This\ncan either be an address/port combination in the form\n`192.168.1.1:4567`, or an interface followed by a port number,\nlike `eth0:4567`. If the port number is omitted, the port\nnumber from the listen address is used. If `AdvertiseAddr` is\nnot specified, it will be automatically detected when possible.\n"
},
"DataPathAddr": {
"type": "string",
"description": "Address or interface to use for data path traffic (format:\n`<ip|interface>`), for example, `192.168.1.1`, or an interface,\nlike `eth0`. If `DataPathAddr` is unspecified, the same address\nas `AdvertiseAddr` is used.\n\nThe `DataPathAddr` specifies the address that global scope\nnetwork drivers will publish towards other nodes in order to\nreach the containers running on this node. Using this parameter\nit is possible to separate the container data traffic from the\nmanagement traffic of the cluster.\n"
},
"RemoteAddrs": {
"type": "array",
"description": "Addresses of manager nodes already participating in the swarm.\n",
"items": {
"type": "string"
}
},
"JoinToken": {
"type": "string",
"description": "Secret token for joining this swarm."
}
},
"example": {
"ListenAddr": "0.0.0.0:2377",
"AdvertiseAddr": "192.168.1.1:2377",
"RemoteAddrs": [
"node1:2377"
],
"JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
}
}
},
"text/plain": {
"schema": {
"title": "SwarmJoinRequest",
"type": "object",
"properties": {
"ListenAddr": {
"type": "string",
"description": "Listen address used for inter-manager communication if the node\ngets promoted to manager, as well as determining the networking\ninterface used for the VXLAN Tunnel Endpoint (VTEP).\n"
},
"AdvertiseAddr": {
"type": "string",
"description": "Externally reachable address advertised to other nodes. This\ncan either be an address/port combination in the form\n`192.168.1.1:4567`, or an interface followed by a port number,\nlike `eth0:4567`. If the port number is omitted, the port\nnumber from the listen address is used. If `AdvertiseAddr` is\nnot specified, it will be automatically detected when possible.\n"
},
"DataPathAddr": {
"type": "string",
"description": "Address or interface to use for data path traffic (format:\n`<ip|interface>`), for example, `192.168.1.1`, or an interface,\nlike `eth0`. If `DataPathAddr` is unspecified, the same address\nas `AdvertiseAddr` is used.\n\nThe `DataPathAddr` specifies the address that global scope\nnetwork drivers will publish towards other nodes in order to\nreach the containers running on this node. Using this parameter\nit is possible to separate the container data traffic from the\nmanagement traffic of the cluster.\n"
},
"RemoteAddrs": {
"type": "array",
"description": "Addresses of manager nodes already participating in the swarm.\n",
"items": {
"type": "string"
}
},
"JoinToken": {
"type": "string",
"description": "Secret token for joining this swarm."
}
},
"example": {
"ListenAddr": "0.0.0.0:2377",
"AdvertiseAddr": "192.168.1.1:2377",
"RemoteAddrs": [
"node1:2377"
],
"JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is already part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/swarm/leave": {
"post": {
"tags": [
"Swarm"
],
"summary": "Leave a swarm",
"operationId": "SwarmLeave",
"parameters": [
{
"name": "force",
"in": "query",
"description": "Force leave swarm, even if this is the last manager or that it will\nbreak the cluster.\n",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/swarm/update": {
"post": {
"tags": [
"Swarm"
],
"summary": "Update a swarm",
"operationId": "SwarmUpdate",
"parameters": [
{
"name": "version",
"in": "query",
"description": "The version number of the swarm object being updated. This is\nrequired to avoid conflicting writes.\n",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "rotateWorkerToken",
"in": "query",
"description": "Rotate the worker join token.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "rotateManagerToken",
"in": "query",
"description": "Rotate the manager join token.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "rotateManagerUnlockKey",
"in": "query",
"description": "Rotate the manager unlock key.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwarmSpec"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SwarmSpec"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/swarm/unlockkey": {
"get": {
"tags": [
"Swarm"
],
"summary": "Get the unlock key",
"operationId": "SwarmUnlockkey",
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"title": "UnlockKeyResponse",
"type": "object",
"properties": {
"UnlockKey": {
"type": "string",
"description": "The swarm's unlock key."
}
},
"example": {
"UnlockKey": "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
}
}
},
"text/plain": {
"schema": {
"title": "UnlockKeyResponse",
"type": "object",
"properties": {
"UnlockKey": {
"type": "string",
"description": "The swarm's unlock key."
}
},
"example": {
"UnlockKey": "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/swarm/unlock": {
"post": {
"tags": [
"Swarm"
],
"summary": "Unlock a locked manager",
"operationId": "SwarmUnlock",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "SwarmUnlockRequest",
"type": "object",
"properties": {
"UnlockKey": {
"type": "string",
"description": "The swarm's unlock key."
}
},
"example": {
"UnlockKey": "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/services": {
"get": {
"tags": [
"Service"
],
"summary": "List services",
"operationId": "ServiceList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the services list.\n\nAvailable filters:\n\n- `id=<service id>`\n- `label=<service label>`\n- `mode=[\"replicated\"|\"global\"]`\n- `name=<service name>`\n",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Include service status, with count of running and desired tasks.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
},
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/services/create": {
"post": {
"tags": [
"Service"
],
"summary": "Create a service",
"operationId": "ServiceCreate",
"parameters": [
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration for pulling from private\nregistries.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceSpec"
},
{
"type": "object",
"example": {
"Name": "web",
"TaskTemplate": {
"ContainerSpec": {
"Image": "nginx:alpine",
"Mounts": [
{
"ReadOnly": true,
"Source": "web-data",
"Target": "/usr/share/nginx/html",
"Type": "volume",
"VolumeOptions": {
"DriverConfig": {},
"Labels": {
"com.example.something": "something-value"
}
}
}
],
"Hosts": [
"10.10.10.10 host1",
"ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2"
],
"User": "33",
"DNSConfig": {
"Nameservers": [
"8.8.8.8"
],
"Search": [
"example.org"
],
"Options": [
"timeout:3"
]
},
"Secrets": [
{
"File": {
"Name": "www.example.org.key",
"UID": "33",
"GID": "33",
"Mode": 384
},
"SecretID": "fpjqlhnwb19zds35k8wn80lq9",
"SecretName": "example_org_domain_key"
}
]
},
"LogDriver": {
"Name": "json-file",
"Options": {
"max-file": "3",
"max-size": "10M"
}
},
"Placement": {},
"Resources": {
"Limits": {
"MemoryBytes": 104857600
},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "on-failure",
"Delay": 10000000000,
"MaxAttempts": 10
}
},
"Mode": {
"Replicated": {
"Replicas": 4
}
},
"UpdateConfig": {
"Parallelism": 2,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"RollbackConfig": {
"Parallelism": 1,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"EndpointSpec": {
"Ports": [
{
"Protocol": "tcp",
"PublishedPort": 8080,
"TargetPort": 80
}
]
},
"Labels": {
"foo": "bar"
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"title": "ServiceCreateResponse",
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "The ID of the created service."
},
"Warning": {
"type": "string",
"description": "Optional warning message"
}
},
"example": {
"ID": "ak7w3gjqoa3kuz8xcpnyy0pvl",
"Warning": "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
}
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "network is not eligible for services",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "name conflicts with an existing service",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/services/{id}": {
"get": {
"tags": [
"Service"
],
"summary": "Inspect a service",
"operationId": "ServiceInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of service.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "insertDefaults",
"in": "query",
"description": "Fill empty fields with default values.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Service"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"404": {
"description": "no such service",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Service"
],
"summary": "Delete a service",
"operationId": "ServiceDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of service.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {}
},
"404": {
"description": "no such service",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/services/{id}/update": {
"post": {
"tags": [
"Service"
],
"summary": "Update a service",
"operationId": "ServiceUpdate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of service.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "The version number of the service object being updated. This is\nrequired to avoid conflicting writes.\nThis version number should be the value as currently set on the\nservice *before* the update. You can find the current version by\ncalling `GET /services/{id}`\n",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "registryAuthFrom",
"in": "query",
"description": "If the `X-Registry-Auth` header is not specified, this parameter\nindicates where to find registry authorization credentials.\n",
"schema": {
"type": "string",
"default": "spec",
"enum": [
"spec",
"previous-spec"
]
}
},
{
"name": "rollback",
"in": "query",
"description": "Set to this parameter to `previous` to cause a server-side rollback\nto the previous service spec. The supplied spec will be ignored in\nthis case.\n",
"schema": {
"type": "string"
}
},
{
"name": "X-Registry-Auth",
"in": "header",
"description": "A base64url-encoded auth configuration for pulling from private\nregistries.\n\nRefer to the [authentication section](#section/Authentication) for\ndetails.\n",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ServiceSpec"
},
{
"type": "object",
"example": {
"Name": "top",
"TaskTemplate": {
"ContainerSpec": {
"Image": "busybox",
"Args": [
"top"
]
},
"Resources": {
"Limits": {},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "any",
"MaxAttempts": 0
},
"Placement": {},
"ForceUpdate": 0
},
"Mode": {
"Replicated": {
"Replicas": 1
}
},
"UpdateConfig": {
"Parallelism": 2,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"RollbackConfig": {
"Parallelism": 1,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"EndpointSpec": {
"Mode": "vip"
}
}
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUpdateResponse"
}
}
}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such service",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/services/{id}/logs": {
"get": {
"tags": [
"Service"
],
"summary": "Get service logs",
"description": "Get `stdout` and `stderr` logs from a service. See also\n[`/containers/{id}/logs`](#operation/ContainerLogs).\n\n**Note**: This endpoint works only for services with the `local`,\n`json-file` or `journald` logging drivers.\n",
"operationId": "ServiceLogs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID or name of the service",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "Show service context and extra details provided to logs.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "follow",
"in": "query",
"description": "Keep connection after returning logs.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdout",
"in": "query",
"description": "Return logs from `stdout`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stderr",
"in": "query",
"description": "Return logs from `stderr`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "since",
"in": "query",
"description": "Only return logs since this time, as a UNIX timestamp",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "timestamps",
"in": "query",
"description": "Add timestamps to every log line",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tail",
"in": "query",
"description": "Only return this number of log lines from the end of the logs.\nSpecify as an integer or `all` to output all log lines.\n",
"schema": {
"type": "string",
"default": "all"
}
}
],
"responses": {
"200": {
"description": "logs returned as a stream in response body",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "no such service",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such service: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/tasks": {
"get": {
"tags": [
"Task"
],
"summary": "List tasks",
"operationId": "TaskList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the tasks list.\n\nAvailable filters:\n\n- `desired-state=(running | shutdown | accepted)`\n- `id=<task id>`\n- `label=key` or `label=\"key=value\"`\n- `name=<task name>`\n- `node=<node id or name>`\n- `service=<service name>`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"ID": "0kzzo1i0y4jz6027t0k7aezc7",
"Version": {
"Index": 71
},
"CreatedAt": "2016-06-07T21:07:31.171892745Z",
"UpdatedAt": "2016-06-07T21:07:31.376370513Z",
"Spec": {
"ContainerSpec": {
"Image": "redis"
},
"Resources": {
"Limits": {},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "any",
"MaxAttempts": 0
},
"Placement": {}
},
"ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
"Slot": 1,
"NodeID": "60gvrl6tm78dmak4yl7srz94v",
"Status": {
"Timestamp": "2016-06-07T21:07:31.290032978Z",
"State": "running",
"Message": "started",
"ContainerStatus": {
"ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035",
"PID": 677
}
},
"DesiredState": "running",
"NetworksAttachments": [
{
"Network": {
"ID": "4qvuz4ko70xaltuqbt8956gd1",
"Version": {
"Index": 18
},
"CreatedAt": "2016-06-07T20:31:11.912919752Z",
"UpdatedAt": "2016-06-07T21:07:29.955277358Z",
"Spec": {
"Name": "ingress",
"Labels": {
"com.docker.swarm.internal": "true"
},
"DriverConfiguration": {},
"IPAMOptions": {
"Driver": {},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"DriverState": {
"Name": "overlay",
"Options": {
"com.docker.network.driver.overlay.vxlanid_list": "256"
}
},
"IPAMOptions": {
"Driver": {
"Name": "default"
},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"Addresses": [
"10.255.0.10/16"
]
}
]
},
{
"ID": "1yljwbmlr8er2waf8orvqpwms",
"Version": {
"Index": 30
},
"CreatedAt": "2016-06-07T21:07:30.019104782Z",
"UpdatedAt": "2016-06-07T21:07:30.231958098Z",
"Name": "hopeful_cori",
"Spec": {
"ContainerSpec": {
"Image": "redis"
},
"Resources": {
"Limits": {},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "any",
"MaxAttempts": 0
},
"Placement": {}
},
"ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
"Slot": 1,
"NodeID": "60gvrl6tm78dmak4yl7srz94v",
"Status": {
"Timestamp": "2016-06-07T21:07:30.202183143Z",
"State": "shutdown",
"Message": "shutdown",
"ContainerStatus": {
"ContainerID": "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213"
}
},
"DesiredState": "shutdown",
"NetworksAttachments": [
{
"Network": {
"ID": "4qvuz4ko70xaltuqbt8956gd1",
"Version": {
"Index": 18
},
"CreatedAt": "2016-06-07T20:31:11.912919752Z",
"UpdatedAt": "2016-06-07T21:07:29.955277358Z",
"Spec": {
"Name": "ingress",
"Labels": {
"com.docker.swarm.internal": "true"
},
"DriverConfiguration": {},
"IPAMOptions": {
"Driver": {},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"DriverState": {
"Name": "overlay",
"Options": {
"com.docker.network.driver.overlay.vxlanid_list": "256"
}
},
"IPAMOptions": {
"Driver": {
"Name": "default"
},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"Addresses": [
"10.255.0.5/16"
]
}
]
}
],
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/tasks/{id}": {
"get": {
"tags": [
"Task"
],
"summary": "Inspect a task",
"operationId": "TaskInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Task"
}
}
}
},
"404": {
"description": "no such task",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/tasks/{id}/logs": {
"get": {
"tags": [
"Task"
],
"summary": "Get task logs",
"description": "Get `stdout` and `stderr` logs from a task.\nSee also [`/containers/{id}/logs`](#operation/ContainerLogs).\n\n**Note**: This endpoint works only for services with the `local`,\n`json-file` or `journald` logging drivers.\n",
"operationId": "TaskLogs",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "details",
"in": "query",
"description": "Show task context and extra details provided to logs.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "follow",
"in": "query",
"description": "Keep connection after returning logs.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stdout",
"in": "query",
"description": "Return logs from `stdout`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "stderr",
"in": "query",
"description": "Return logs from `stderr`",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "since",
"in": "query",
"description": "Only return logs since this time, as a UNIX timestamp",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "timestamps",
"in": "query",
"description": "Add timestamps to every log line",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "tail",
"in": "query",
"description": "Only return this number of log lines from the end of the logs.\nSpecify as an integer or `all` to output all log lines.\n",
"schema": {
"type": "string",
"default": "all"
}
}
],
"responses": {
"200": {
"description": "logs returned as a stream in response body",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "no such task",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"example": {
"message": "No such task: c2ada9df5af8"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/vnd.docker.multiplexed-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/secrets": {
"get": {
"tags": [
"Secret"
],
"summary": "List secrets",
"operationId": "SecretList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the secrets list.\n\nAvailable filters:\n\n- `id=<secret id>`\n- `label=<key> or label=<key>=value`\n- `name=<secret name>`\n- `names=<secret name>`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"ID": "blt1owaxmitz71s9v5zh81zun",
"Version": {
"Index": 85
},
"CreatedAt": "2017-07-20T13:55:28.678958722Z",
"UpdatedAt": "2017-07-20T13:55:28.678958722Z",
"Spec": {
"Name": "mysql-passwd",
"Labels": {
"some.label": "some.value"
},
"Driver": {
"Name": "secret-bucket",
"Options": {
"OptionA": "value for driver option A",
"OptionB": "value for driver option B"
}
}
}
},
{
"ID": "ktnbjxoalbkvbvedmg1urrz8h",
"Version": {
"Index": 11
},
"CreatedAt": "2016-11-05T01:20:17.327670065Z",
"UpdatedAt": "2016-11-05T01:20:17.327670065Z",
"Spec": {
"Name": "app-dev.crt",
"Labels": {
"foo": "bar"
}
}
}
],
"items": {
"$ref": "#/components/schemas/Secret"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/secrets/create": {
"post": {
"tags": [
"Secret"
],
"summary": "Create a secret",
"operationId": "SecretCreate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SecretSpec"
},
{
"type": "object",
"example": {
"Name": "app-key.crt",
"Labels": {
"foo": "bar"
},
"Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==",
"Driver": {
"Name": "secret-bucket",
"Options": {
"OptionA": "value for driver option A",
"OptionB": "value for driver option B"
}
}
}
}
]
}
}
},
"required": false
},
"responses": {
"201": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"409": {
"description": "name conflicts with an existing object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/secrets/{id}": {
"get": {
"tags": [
"Secret"
],
"summary": "Inspect a secret",
"operationId": "SecretInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the secret",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
},
"example": {
"ID": "ktnbjxoalbkvbvedmg1urrz8h",
"Version": {
"Index": 11
},
"CreatedAt": "2016-11-05T01:20:17.327670065Z",
"UpdatedAt": "2016-11-05T01:20:17.327670065Z",
"Spec": {
"Name": "app-dev.crt",
"Labels": {
"foo": "bar"
},
"Driver": {
"Name": "secret-bucket",
"Options": {
"OptionA": "value for driver option A",
"OptionB": "value for driver option B"
}
}
}
}
}
}
},
"404": {
"description": "secret not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Secret"
],
"summary": "Delete a secret",
"operationId": "SecretDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the secret",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "secret not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/secrets/{id}/update": {
"post": {
"tags": [
"Secret"
],
"summary": "Update a Secret",
"operationId": "SecretUpdate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID or name of the secret",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "The version number of the secret object being updated. This is\nrequired to avoid conflicting writes.\n",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The spec of the secret to update. Currently, only the Labels field\ncan be updated. All other fields must remain unchanged from the\n[SecretInspect endpoint](#operation/SecretInspect) response values.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SecretSpec"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SecretSpec"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such secret",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/configs": {
"get": {
"tags": [
"Config"
],
"summary": "List configs",
"operationId": "ConfigList",
"parameters": [
{
"name": "filters",
"in": "query",
"description": "A JSON encoded value of the filters (a `map[string][]string`) to\nprocess on the configs list.\n\nAvailable filters:\n\n- `id=<config id>`\n- `label=<key> or label=<key>=value`\n- `name=<config name>`\n- `names=<config name>`\n",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"type": "array",
"example": [
{
"ID": "ktnbjxoalbkvbvedmg1urrz8h",
"Version": {
"Index": 11
},
"CreatedAt": "2016-11-05T01:20:17.327670065Z",
"UpdatedAt": "2016-11-05T01:20:17.327670065Z",
"Spec": {
"Name": "server.conf"
}
}
],
"items": {
"$ref": "#/components/schemas/Config"
}
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/configs/create": {
"post": {
"tags": [
"Config"
],
"summary": "Create a config",
"operationId": "ConfigCreate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigSpec"
},
{
"type": "object",
"example": {
"Name": "server.conf",
"Labels": {
"foo": "bar"
},
"Data": "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="
}
}
]
}
}
},
"required": false
},
"responses": {
"201": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdResponse"
}
}
}
},
"409": {
"description": "name conflicts with an existing object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/configs/{id}": {
"get": {
"tags": [
"Config"
],
"summary": "Inspect a config",
"operationId": "ConfigInspect",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the config",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "no error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Config"
},
"example": {
"ID": "ktnbjxoalbkvbvedmg1urrz8h",
"Version": {
"Index": 11
},
"CreatedAt": "2016-11-05T01:20:17.327670065Z",
"UpdatedAt": "2016-11-05T01:20:17.327670065Z",
"Spec": {
"Name": "app-dev.crt"
}
}
}
}
},
"404": {
"description": "config not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Config"
],
"summary": "Delete a config",
"operationId": "ConfigDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the config",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "no error",
"content": {}
},
"404": {
"description": "config not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/configs/{id}/update": {
"post": {
"tags": [
"Config"
],
"summary": "Update a Config",
"operationId": "ConfigUpdate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID or name of the config",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "The version number of the config object being updated. This is\nrequired to avoid conflicting writes.\n",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The spec of the config to update. Currently, only the Labels field\ncan be updated. All other fields must remain unchanged from the\n[ConfigInspect endpoint](#operation/ConfigInspect) response values.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigSpec"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ConfigSpec"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "no error",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "no such config",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "node is not part of a swarm",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/distribution/{name}/json": {
"get": {
"tags": [
"Distribution"
],
"summary": "Get image information from the registry",
"description": "Return image digest and platform information by contacting the registry.\n",
"operationId": "DistributionInspect",
"parameters": [
{
"name": "name",
"in": "path",
"description": "Image name or id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "descriptor and platform information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DistributionInspect"
}
}
}
},
"401": {
"description": "Failed authentication or no image found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "No such image: someimage (tag: latest)"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/session": {
"post": {
"tags": [
"Session"
],
"summary": "Initialize interactive session",
"description": "Start a new interactive session with a server. Session allows server to\ncall back to the client for advanced capabilities.\n\n### Hijacking\n\nThis endpoint hijacks the HTTP connection to HTTP2 transport that allows\nthe client to expose gPRC services on that connection.\n\nFor example, the client sends this request to upgrade the connection:\n\n```\nPOST /session HTTP/1.1\nUpgrade: h2c\nConnection: Upgrade\n```\n\nThe Docker daemon responds with a `101 UPGRADED` response follow with\nthe raw stream:\n\n```\nHTTP/1.1 101 UPGRADED\nConnection: Upgrade\nUpgrade: h2c\n```\n",
"operationId": "Session",
"responses": {
"101": {
"description": "no error, hijacking successful",
"content": {}
},
"400": {
"description": "bad parameter",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "server error",
"content": {
"application/vnd.docker.raw-stream": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Port": {
"required": [
"PrivatePort",
"Type"
],
"type": "object",
"properties": {
"IP": {
"type": "string",
"description": "Host IP address that the container's port is mapped to",
"format": "ip-address"
},
"PrivatePort": {
"type": "integer",
"description": "Port on the container",
"format": "uint16",
"nullable": false
},
"PublicPort": {
"type": "integer",
"description": "Port exposed on the host",
"format": "uint16"
},
"Type": {
"type": "string",
"nullable": false,
"enum": [
"tcp",
"udp",
"sctp"
]
}
},
"description": "An open port on a container",
"example": {
"PrivatePort": 8080,
"PublicPort": 80,
"Type": "tcp"
}
},
"MountPoint": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"description": "The mount type:\n\n- `bind` a mount of a file or directory from the host into the container.\n- `volume` a docker volume with the given `Name`.\n- `tmpfs` a `tmpfs`.\n- `npipe` a named pipe from the host into the container.\n- `cluster` a Swarm cluster volume\n",
"example": "volume",
"enum": [
"bind",
"volume",
"tmpfs",
"npipe",
"cluster"
]
},
"Name": {
"type": "string",
"description": "Name is the name reference to the underlying data defined by `Source`\ne.g., the volume name.\n",
"example": "myvolume"
},
"Source": {
"type": "string",
"description": "Source location of the mount.\n\nFor volumes, this contains the storage location of the volume (within\n`/var/lib/docker/volumes/`). For bind-mounts, and `npipe`, this contains\nthe source (host) part of the bind-mount. For `tmpfs` mount points, this\nfield is empty.\n",
"example": "/var/lib/docker/volumes/myvolume/_data"
},
"Destination": {
"type": "string",
"description": "Destination is the path relative to the container root (`/`) where\nthe `Source` is mounted inside the container.\n",
"example": "/usr/share/nginx/html/"
},
"Driver": {
"type": "string",
"description": "Driver is the volume driver used to create the volume (if it is a volume).\n",
"example": "local"
},
"Mode": {
"type": "string",
"description": "Mode is a comma separated list of options supplied by the user when\ncreating the bind/volume mount.\n\nThe default is platform-specific (`\"z\"` on Linux, empty on Windows).\n",
"example": "z"
},
"RW": {
"type": "boolean",
"description": "Whether the mount is mounted writable (read-write).\n",
"example": true
},
"Propagation": {
"type": "string",
"description": "Propagation describes how mounts are propagated from the host into the\nmount point, and vice-versa. Refer to the [Linux kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt)\nfor details. This field is not used on Windows.\n",
"example": ""
}
},
"description": "MountPoint represents a mount point configuration inside the container.\nThis is used for reporting the mountpoints in use by a container.\n"
},
"DeviceMapping": {
"type": "object",
"properties": {
"PathOnHost": {
"type": "string"
},
"PathInContainer": {
"type": "string"
},
"CgroupPermissions": {
"type": "string"
}
},
"description": "A device mapping between the host and container",
"example": {
"PathOnHost": "/dev/deviceName",
"PathInContainer": "/dev/deviceName",
"CgroupPermissions": "mrw"
}
},
"DeviceRequest": {
"type": "object",
"properties": {
"Driver": {
"type": "string",
"example": "nvidia"
},
"Count": {
"type": "integer",
"example": -1
},
"DeviceIDs": {
"type": "array",
"example": [
"0",
"1",
"GPU-fef8089b-4820-abfc-e83e-94318197576e"
],
"items": {
"type": "string"
}
},
"Capabilities": {
"type": "array",
"description": "A list of capabilities; an OR list of AND lists of capabilities.\n",
"example": [
[
"gpu",
"nvidia",
"compute"
]
],
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Driver-specific options, specified as a key/value pairs. These options\nare passed directly to the driver.\n"
}
},
"description": "A request for devices to be sent to device drivers"
},
"ThrottleDevice": {
"type": "object",
"properties": {
"Path": {
"type": "string",
"description": "Device path"
},
"Rate": {
"minimum": 0,
"type": "integer",
"description": "Rate",
"format": "int64"
}
}
},
"Mount": {
"type": "object",
"properties": {
"Target": {
"type": "string",
"description": "Container path."
},
"Source": {
"type": "string",
"description": "Mount source (e.g. a volume name, a host path)."
},
"Type": {
"type": "string",
"description": "The mount type. Available types:\n\n- `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container.\n- `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed.\n- `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.\n- `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.\n- `cluster` a Swarm cluster volume\n",
"enum": [
"bind",
"volume",
"tmpfs",
"npipe",
"cluster"
]
},
"ReadOnly": {
"type": "boolean",
"description": "Whether the mount should be read-only."
},
"Consistency": {
"type": "string",
"description": "The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`."
},
"BindOptions": {
"type": "object",
"properties": {
"Propagation": {
"type": "string",
"description": "A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.",
"enum": [
"private",
"rprivate",
"shared",
"rshared",
"slave",
"rslave"
]
},
"NonRecursive": {
"type": "boolean",
"description": "Disable recursive bind mount.",
"default": false
},
"CreateMountpoint": {
"type": "boolean",
"description": "Create mount point on host if missing",
"default": false
}
},
"description": "Optional configuration for the `bind` type."
},
"VolumeOptions": {
"type": "object",
"properties": {
"NoCopy": {
"type": "boolean",
"description": "Populate volume with data from the target.",
"default": false
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"DriverConfig": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the driver to use to create the volume."
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "key/value map of driver specific options."
}
},
"description": "Map of driver specific options"
}
},
"description": "Optional configuration for the `volume` type."
},
"TmpfsOptions": {
"type": "object",
"properties": {
"SizeBytes": {
"type": "integer",
"description": "The size for the tmpfs mount in bytes.",
"format": "int64"
},
"Mode": {
"type": "integer",
"description": "The permission mode for the tmpfs mount in an integer."
}
},
"description": "Optional configuration for the `tmpfs` type."
}
}
},
"RestartPolicy": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "- Empty string means not to restart\n- `no` Do not automatically restart\n- `always` Always restart\n- `unless-stopped` Restart always except when the user has manually stopped the container\n- `on-failure` Restart only when the container exit code is non-zero\n",
"enum": [
"",
"no",
"always",
"unless-stopped",
"on-failure"
]
},
"MaximumRetryCount": {
"type": "integer",
"description": "If `on-failure` is used, the number of times to retry before giving up.\n"
}
},
"description": "The behavior to apply when the container exits. The default is not to\nrestart.\n\nAn ever increasing delay (double the previous delay, starting at 100ms) is\nadded before each restart to prevent flooding the server.\n"
},
"Resources": {
"type": "object",
"properties": {
"CpuShares": {
"type": "integer",
"description": "An integer value representing this container's relative CPU weight\nversus other containers.\n"
},
"Memory": {
"type": "integer",
"description": "Memory limit in bytes.",
"format": "int64",
"default": 0
},
"CgroupParent": {
"type": "string",
"description": "Path to `cgroups` under which the container's `cgroup` is created. If\nthe path is not absolute, the path is considered to be relative to the\n`cgroups` path of the init process. Cgroups are created if they do not\nalready exist.\n"
},
"BlkioWeight": {
"maximum": 1E+3,
"minimum": 0,
"type": "integer",
"description": "Block IO weight (relative weight)."
},
"BlkioWeightDevice": {
"type": "array",
"description": "Block IO weight (relative device weight) in the form:\n\n```\n[{\"Path\": \"device_path\", \"Weight\": weight}]\n```\n",
"items": {
"type": "object",
"properties": {
"Path": {
"type": "string"
},
"Weight": {
"minimum": 0,
"type": "integer"
}
}
}
},
"BlkioDeviceReadBps": {
"type": "array",
"description": "Limit read rate (bytes per second) from a device, in the form:\n\n```\n[{\"Path\": \"device_path\", \"Rate\": rate}]\n```\n",
"items": {
"$ref": "#/components/schemas/ThrottleDevice"
}
},
"BlkioDeviceWriteBps": {
"type": "array",
"description": "Limit write rate (bytes per second) to a device, in the form:\n\n```\n[{\"Path\": \"device_path\", \"Rate\": rate}]\n```\n",
"items": {
"$ref": "#/components/schemas/ThrottleDevice"
}
},
"BlkioDeviceReadIOps": {
"type": "array",
"description": "Limit read rate (IO per second) from a device, in the form:\n\n```\n[{\"Path\": \"device_path\", \"Rate\": rate}]\n```\n",
"items": {
"$ref": "#/components/schemas/ThrottleDevice"
}
},
"BlkioDeviceWriteIOps": {
"type": "array",
"description": "Limit write rate (IO per second) to a device, in the form:\n\n```\n[{\"Path\": \"device_path\", \"Rate\": rate}]\n```\n",
"items": {
"$ref": "#/components/schemas/ThrottleDevice"
}
},
"CpuPeriod": {
"type": "integer",
"description": "The length of a CPU period in microseconds.",
"format": "int64"
},
"CpuQuota": {
"type": "integer",
"description": "Microseconds of CPU time that the container can get in a CPU period.\n",
"format": "int64"
},
"CpuRealtimePeriod": {
"type": "integer",
"description": "The length of a CPU real-time period in microseconds. Set to 0 to\nallocate no time allocated to real-time tasks.\n",
"format": "int64"
},
"CpuRealtimeRuntime": {
"type": "integer",
"description": "The length of a CPU real-time runtime in microseconds. Set to 0 to\nallocate no time allocated to real-time tasks.\n",
"format": "int64"
},
"CpusetCpus": {
"type": "string",
"description": "CPUs in which to allow execution (e.g., `0-3`, `0,1`).\n",
"example": "0-3"
},
"CpusetMems": {
"type": "string",
"description": "Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only\neffective on NUMA systems.\n"
},
"Devices": {
"type": "array",
"description": "A list of devices to add to the container.",
"items": {
"$ref": "#/components/schemas/DeviceMapping"
}
},
"DeviceCgroupRules": {
"type": "array",
"description": "a list of cgroup rules to apply to the container",
"items": {
"type": "string",
"example": "c 13:* rwm"
}
},
"DeviceRequests": {
"type": "array",
"description": "A list of requests for devices to be sent to device drivers.\n",
"items": {
"$ref": "#/components/schemas/DeviceRequest"
}
},
"KernelMemoryTCP": {
"type": "integer",
"description": "Hard limit for kernel TCP buffer memory (in bytes). Depending on the\nOCI runtime in use, this option may be ignored. It is no longer supported\nby the default (runc) runtime.\n\nThis field is omitted when empty.\n",
"format": "int64"
},
"MemoryReservation": {
"type": "integer",
"description": "Memory soft limit in bytes.",
"format": "int64"
},
"MemorySwap": {
"type": "integer",
"description": "Total memory limit (memory + swap). Set as `-1` to enable unlimited\nswap.\n",
"format": "int64"
},
"MemorySwappiness": {
"maximum": 1E+2,
"minimum": 0,
"type": "integer",
"description": "Tune a container's memory swappiness behavior. Accepts an integer\nbetween 0 and 100.\n",
"format": "int64"
},
"NanoCpus": {
"type": "integer",
"description": "CPU quota in units of 10<sup>-9</sup> CPUs.",
"format": "int64"
},
"OomKillDisable": {
"type": "boolean",
"description": "Disable OOM Killer for the container."
},
"Init": {
"type": "boolean",
"description": "Run an init inside the container that forwards signals and reaps\nprocesses. This field is omitted if empty, and the default (as\nconfigured on the daemon) is used.\n",
"nullable": true
},
"PidsLimit": {
"type": "integer",
"description": "Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`\nto not change.\n",
"format": "int64",
"nullable": true
},
"Ulimits": {
"type": "array",
"description": "A list of resource limits to set in the container. For example:\n\n```\n{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}\n```\n",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of ulimit"
},
"Soft": {
"type": "integer",
"description": "Soft limit"
},
"Hard": {
"type": "integer",
"description": "Hard limit"
}
}
}
},
"CpuCount": {
"type": "integer",
"description": "The number of usable CPUs (Windows only).\n\nOn Windows Server containers, the processor resource controls are\nmutually exclusive. The order of precedence is `CPUCount` first, then\n`CPUShares`, and `CPUPercent` last.\n",
"format": "int64"
},
"CpuPercent": {
"type": "integer",
"description": "The usable percentage of the available CPUs (Windows only).\n\nOn Windows Server containers, the processor resource controls are\nmutually exclusive. The order of precedence is `CPUCount` first, then\n`CPUShares`, and `CPUPercent` last.\n",
"format": "int64"
},
"IOMaximumIOps": {
"type": "integer",
"description": "Maximum IOps for the container system drive (Windows only)",
"format": "int64"
},
"IOMaximumBandwidth": {
"type": "integer",
"description": "Maximum IO in bytes per second for the container system drive\n(Windows only).\n",
"format": "int64"
}
},
"description": "A container's resources (cgroups config, ulimits, etc)"
},
"Limit": {
"type": "object",
"properties": {
"NanoCPUs": {
"type": "integer",
"format": "int64",
"example": 4000000000
},
"MemoryBytes": {
"type": "integer",
"format": "int64",
"example": 8272408576
},
"Pids": {
"type": "integer",
"description": "Limits the maximum number of PIDs in the container. Set `0` for unlimited.\n",
"format": "int64",
"example": 100,
"default": 0
}
},
"description": "An object describing a limit on resources which can be requested by a task.\n"
},
"ResourceObject": {
"type": "object",
"properties": {
"NanoCPUs": {
"type": "integer",
"format": "int64",
"example": 4000000000
},
"MemoryBytes": {
"type": "integer",
"format": "int64",
"example": 8272408576
},
"GenericResources": {
"$ref": "#/components/schemas/GenericResources"
}
},
"description": "An object describing the resources which can be advertised by a node and\nrequested by a task.\n"
},
"GenericResources": {
"type": "array",
"description": "User-defined resources can be either Integer resources (e.g, `SSD=3`) or\nString resources (e.g, `GPU=UUID1`).\n",
"example": [
{
"DiscreteResourceSpec": {
"Kind": "SSD",
"Value": 3
}
},
{
"NamedResourceSpec": {
"Kind": "GPU",
"Value": "UUID1"
}
},
{
"NamedResourceSpec": {
"Kind": "GPU",
"Value": "UUID2"
}
}
],
"items": {
"type": "object",
"properties": {
"NamedResourceSpec": {
"type": "object",
"properties": {
"Kind": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"DiscreteResourceSpec": {
"type": "object",
"properties": {
"Kind": {
"type": "string"
},
"Value": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"HealthConfig": {
"type": "object",
"properties": {
"Test": {
"type": "array",
"description": "The test to perform. Possible values are:\n\n- `[]` inherit healthcheck from image or parent image\n- `[\"NONE\"]` disable healthcheck\n- `[\"CMD\", args...]` exec arguments directly\n- `[\"CMD-SHELL\", command]` run command with system's default shell\n",
"items": {
"type": "string"
}
},
"Interval": {
"type": "integer",
"description": "The time to wait between checks in nanoseconds. It should be 0 or at\nleast 1000000 (1 ms). 0 means inherit.\n",
"format": "int64"
},
"Timeout": {
"type": "integer",
"description": "The time to wait before considering the check to have hung. It should\nbe 0 or at least 1000000 (1 ms). 0 means inherit.\n",
"format": "int64"
},
"Retries": {
"type": "integer",
"description": "The number of consecutive failures needed to consider a container as\nunhealthy. 0 means inherit.\n"
},
"StartPeriod": {
"type": "integer",
"description": "Start period for the container to initialize before starting\nhealth-retries countdown in nanoseconds. It should be 0 or at least\n1000000 (1 ms). 0 means inherit.\n",
"format": "int64"
}
},
"description": "A test to perform to check that the container is healthy."
},
"Health": {
"type": "object",
"properties": {
"Status": {
"type": "string",
"description": "Status is one of `none`, `starting`, `healthy` or `unhealthy`\n\n- \"none\" Indicates there is no healthcheck\n- \"starting\" Starting indicates that the container is not yet ready\n- \"healthy\" Healthy indicates that the container is running correctly\n- \"unhealthy\" Unhealthy indicates that the container has a problem\n",
"example": "healthy",
"enum": [
"none",
"starting",
"healthy",
"unhealthy"
]
},
"FailingStreak": {
"type": "integer",
"description": "FailingStreak is the number of consecutive failures",
"example": 0
},
"Log": {
"type": "array",
"description": "Log contains the last few results (oldest first)\n",
"items": {
"$ref": "#/components/schemas/HealthcheckResult"
}
}
},
"description": "Health stores information about the container's healthcheck results.\n",
"nullable": true,
"x-nullable": true
},
"HealthcheckResult": {
"type": "object",
"properties": {
"Start": {
"type": "string",
"description": "Date and time at which this check started in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "date-time",
"example": "2020-01-04T10:44:24.496525531Z"
},
"End": {
"type": "string",
"description": "Date and time at which this check ended in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2020-01-04T10:45:21.364524523Z"
},
"ExitCode": {
"type": "integer",
"description": "ExitCode meanings:\n\n- `0` healthy\n- `1` unhealthy\n- `2` reserved (considered unhealthy)\n- other values: error running probe\n",
"example": 0
},
"Output": {
"type": "string",
"description": "Output from last check"
}
},
"description": "HealthcheckResult stores information about a single run of a healthcheck probe\n",
"nullable": true,
"x-nullable": true
},
"HostConfig": {
"description": "Container configuration that depends on the host we are running on",
"allOf": [
{
"$ref": "#/components/schemas/Resources"
},
{
"type": "object",
"properties": {
"Binds": {
"type": "array",
"description": "A list of volume bindings for this container. Each volume binding\nis a string in one of these forms:\n\n- `host-src:container-dest[:options]` to bind-mount a host path\n into the container. Both `host-src`, and `container-dest` must\n be an _absolute_ path.\n- `volume-name:container-dest[:options]` to bind-mount a volume\n managed by a volume driver into the container. `container-dest`\n must be an _absolute_ path.\n\n`options` is an optional, comma-delimited list of:\n\n- `nocopy` disables automatic copying of data from the container\n path to the volume. The `nocopy` flag only applies to named volumes.\n- `[ro|rw]` mounts a volume read-only or read-write, respectively.\n If omitted or set to `rw`, volumes are mounted read-write.\n- `[z|Z]` applies SELinux labels to allow or deny multiple containers\n to read and write to the same volume.\n - `z`: a _shared_ content label is applied to the content. This\n label indicates that multiple containers can share the volume\n content, for both reading and writing.\n - `Z`: a _private unshared_ label is applied to the content.\n This label indicates that only the current container can use\n a private volume. Labeling systems such as SELinux require\n proper labels to be placed on volume content that is mounted\n into a container. Without a label, the security system can\n prevent a container's processes from using the content. By\n default, the labels set by the host operating system are not\n modified.\n- `[[r]shared|[r]slave|[r]private]` specifies mount\n [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt).\n This only applies to bind-mounted volumes, not internal volumes\n or named volumes. Mount propagation requires the source mount\n point (the location where the source directory is mounted in the\n host operating system) to have the correct propagation properties.\n For shared volumes, the source mount point must be set to `shared`.\n For slave volumes, the mount must be set to either `shared` or\n `slave`.\n",
"items": {
"type": "string"
}
},
"ContainerIDFile": {
"type": "string",
"description": "Path to a file where the container ID is written"
},
"LogConfig": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"enum": [
"json-file",
"syslog",
"journald",
"gelf",
"fluentd",
"awslogs",
"splunk",
"etwlogs",
"none"
]
},
"Config": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"description": "The logging configuration for this container"
},
"NetworkMode": {
"type": "string",
"description": "Network mode to use for this container. Supported standard values\nare: `bridge`, `host`, `none`, and `container:<name|id>`. Any\nother value is taken as a custom network's name to which this\ncontainer should connect to.\n"
},
"PortBindings": {
"$ref": "#/components/schemas/PortMap"
},
"RestartPolicy": {
"$ref": "#/components/schemas/RestartPolicy"
},
"AutoRemove": {
"type": "boolean",
"description": "Automatically remove the container when the container's process\nexits. This has no effect if `RestartPolicy` is set.\n"
},
"VolumeDriver": {
"type": "string",
"description": "Driver that this container uses to mount volumes."
},
"VolumesFrom": {
"type": "array",
"description": "A list of volumes to inherit from another container, specified in\nthe form `<container name>[:<ro|rw>]`.\n",
"items": {
"type": "string"
}
},
"Mounts": {
"type": "array",
"description": "Specification for mounts to be added to the container.\n",
"items": {
"$ref": "#/components/schemas/Mount"
}
},
"ConsoleSize": {
"maxItems": 2,
"minItems": 2,
"type": "array",
"description": "Initial console size, as an `[height, width]` array.\n",
"nullable": true,
"items": {
"minimum": 0,
"type": "integer"
}
},
"Annotations": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Arbitrary non-identifying metadata attached to container and\nprovided to the runtime when the container is started.\n"
},
"CapAdd": {
"type": "array",
"description": "A list of kernel capabilities to add to the container. Conflicts\nwith option 'Capabilities'.\n",
"items": {
"type": "string"
}
},
"CapDrop": {
"type": "array",
"description": "A list of kernel capabilities to drop from the container. Conflicts\nwith option 'Capabilities'.\n",
"items": {
"type": "string"
}
},
"CgroupnsMode": {
"type": "string",
"description": "cgroup namespace mode for the container. Possible values are:\n\n- `\"private\"`: the container runs in its own private cgroup namespace\n- `\"host\"`: use the host system's cgroup namespace\n\nIf not specified, the daemon default is used, which can either be `\"private\"`\nor `\"host\"`, depending on daemon version, kernel support and configuration.\n",
"enum": [
"private",
"host"
]
},
"Dns": {
"type": "array",
"description": "A list of DNS servers for the container to use.",
"items": {
"type": "string"
}
},
"DnsOptions": {
"type": "array",
"description": "A list of DNS options.",
"items": {
"type": "string"
}
},
"DnsSearch": {
"type": "array",
"description": "A list of DNS search domains.",
"items": {
"type": "string"
}
},
"ExtraHosts": {
"type": "array",
"description": "A list of hostnames/IP mappings to add to the container's `/etc/hosts`\nfile. Specified in the form `[\"hostname:IP\"]`.\n",
"items": {
"type": "string"
}
},
"GroupAdd": {
"type": "array",
"description": "A list of additional groups that the container process will run as.\n",
"items": {
"type": "string"
}
},
"IpcMode": {
"type": "string",
"description": "IPC sharing mode for the container. Possible values are:\n\n- `\"none\"`: own private IPC namespace, with /dev/shm not mounted\n- `\"private\"`: own private IPC namespace\n- `\"shareable\"`: own private IPC namespace, with a possibility to share it with other containers\n- `\"container:<name|id>\"`: join another (shareable) container's IPC namespace\n- `\"host\"`: use the host system's IPC namespace\n\nIf not specified, daemon default is used, which can either be `\"private\"`\nor `\"shareable\"`, depending on daemon version and configuration.\n"
},
"Cgroup": {
"type": "string",
"description": "Cgroup to use for the container."
},
"Links": {
"type": "array",
"description": "A list of links for the container in the form `container_name:alias`.\n",
"items": {
"type": "string"
}
},
"OomScoreAdj": {
"type": "integer",
"description": "An integer value containing the score given to the container in\norder to tune OOM killer preferences.\n",
"example": 500
},
"PidMode": {
"type": "string",
"description": "Set the PID (Process) Namespace mode for the container. It can be\neither:\n\n- `\"container:<name|id>\"`: joins another container's PID namespace\n- `\"host\"`: use the host's PID namespace inside the container\n"
},
"Privileged": {
"type": "boolean",
"description": "Gives the container full access to the host."
},
"PublishAllPorts": {
"type": "boolean",
"description": "Allocates an ephemeral host port for all of a container's\nexposed ports.\n\nPorts are de-allocated when the container stops and allocated when\nthe container starts. The allocated port might be changed when\nrestarting the container.\n\nThe port is selected from the ephemeral port range that depends on\nthe kernel. For example, on Linux the range is defined by\n`/proc/sys/net/ipv4/ip_local_port_range`.\n"
},
"ReadonlyRootfs": {
"type": "boolean",
"description": "Mount the container's root filesystem as read only."
},
"SecurityOpt": {
"type": "array",
"description": "A list of string values to customize labels for MLS systems, such\nas SELinux.\n",
"items": {
"type": "string"
}
},
"StorageOpt": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Storage driver options for this container, in the form `{\"size\": \"120G\"}`.\n"
},
"Tmpfs": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of container directories which should be replaced by tmpfs\nmounts, and their corresponding mount options. For example:\n\n```\n{ \"/run\": \"rw,noexec,nosuid,size=65536k\" }\n```\n"
},
"UTSMode": {
"type": "string",
"description": "UTS namespace to use for the container."
},
"UsernsMode": {
"type": "string",
"description": "Sets the usernamespace mode for the container when usernamespace\nremapping option is enabled.\n"
},
"ShmSize": {
"minimum": 0,
"type": "integer",
"description": "Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.\n",
"format": "int64"
},
"Sysctls": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A list of kernel parameters (sysctls) to set in the container.\nFor example:\n\n```\n{\"net.ipv4.ip_forward\": \"1\"}\n```\n"
},
"Runtime": {
"type": "string",
"description": "Runtime to use with this container."
},
"Isolation": {
"type": "string",
"description": "Isolation technology of the container. (Windows only)\n",
"enum": [
"default",
"process",
"hyperv"
]
},
"MaskedPaths": {
"type": "array",
"description": "The list of paths to be masked inside the container (this overrides\nthe default set of paths).\n",
"items": {
"type": "string"
}
},
"ReadonlyPaths": {
"type": "array",
"description": "The list of paths to be set as read-only inside the container\n(this overrides the default set of paths).\n",
"items": {
"type": "string"
}
}
}
}
]
},
"ContainerConfig": {
"type": "object",
"properties": {
"Hostname": {
"type": "string",
"description": "The hostname to use for the container, as a valid RFC 1123 hostname.\n",
"example": "439f4e91bd1d"
},
"Domainname": {
"type": "string",
"description": "The domain name to use for the container.\n"
},
"User": {
"type": "string",
"description": "The user that commands are run as inside the container."
},
"AttachStdin": {
"type": "boolean",
"description": "Whether to attach to `stdin`.",
"default": false
},
"AttachStdout": {
"type": "boolean",
"description": "Whether to attach to `stdout`.",
"default": true
},
"AttachStderr": {
"type": "boolean",
"description": "Whether to attach to `stderr`.",
"default": true
},
"ExposedPorts": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
},
"description": "An object mapping ports to an empty object in the form:\n\n`{\"<port>/<tcp|udp|sctp>\": {}}`\n",
"nullable": true,
"example": {
"80/tcp": {},
"443/tcp": {}
}
},
"Tty": {
"type": "boolean",
"description": "Attach standard streams to a TTY, including `stdin` if it is not closed.\n",
"default": false
},
"OpenStdin": {
"type": "boolean",
"description": "Open `stdin`",
"default": false
},
"StdinOnce": {
"type": "boolean",
"description": "Close `stdin` after one attached client disconnects",
"default": false
},
"Env": {
"type": "array",
"description": "A list of environment variables to set inside the container in the\nform `[\"VAR=value\", ...]`. A variable without `=` is removed from the\nenvironment, rather than to have an empty value.\n",
"example": [
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
],
"items": {
"type": "string"
}
},
"Cmd": {
"type": "array",
"description": "Command to run specified as a string or an array of strings.\n",
"example": [
"/bin/sh"
],
"items": {
"type": "string"
}
},
"Healthcheck": {
"$ref": "#/components/schemas/HealthConfig"
},
"ArgsEscaped": {
"type": "boolean",
"description": "Command is already escaped (Windows only)",
"nullable": true,
"example": false,
"default": false
},
"Image": {
"type": "string",
"description": "The name (or reference) of the image to use when creating the container,\nor which was used when the container was created.\n",
"example": "example-image:1.0"
},
"Volumes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
},
"description": "An object mapping mount point paths inside the container to empty\nobjects.\n"
},
"WorkingDir": {
"type": "string",
"description": "The working directory for commands to run in.",
"example": "/public/"
},
"Entrypoint": {
"type": "array",
"description": "The entry point for the container as a string or an array of strings.\n\nIf the array consists of exactly one empty string (`[\"\"]`) then the\nentry point is reset to system default (i.e., the entry point used by\ndocker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).\n",
"example": [],
"items": {
"type": "string"
}
},
"NetworkDisabled": {
"type": "boolean",
"description": "Disable networking for the container.",
"nullable": true
},
"MacAddress": {
"type": "string",
"description": "MAC address of the container.",
"nullable": true
},
"OnBuild": {
"type": "array",
"description": "`ONBUILD` metadata that were defined in the image's `Dockerfile`.\n",
"nullable": true,
"example": [],
"items": {
"type": "string"
}
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
},
"StopSignal": {
"type": "string",
"description": "Signal to stop a container as a string or unsigned integer.\n",
"nullable": true,
"example": "SIGTERM"
},
"StopTimeout": {
"type": "integer",
"description": "Timeout to stop a container in seconds.",
"nullable": true
},
"Shell": {
"type": "array",
"description": "Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.\n",
"nullable": true,
"example": [
"/bin/sh",
"-c"
],
"items": {
"type": "string"
}
}
},
"description": "Configuration for a container that is portable between hosts.\n\nWhen used as `ContainerConfig` field in an image, `ContainerConfig` is an\noptional field containing the configuration of the container that was last\ncommitted when creating the image.\n\nPrevious versions of Docker builder used this field to store build cache,\nand it is not in active use anymore.\n"
},
"NetworkingConfig": {
"type": "object",
"properties": {
"EndpointsConfig": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EndpointSettings"
},
"description": "A mapping of network name to endpoint configuration for that network.\n"
}
},
"description": "NetworkingConfig represents the container's networking configuration for\neach of its interfaces.\nIt is used for the networking configs specified in the `docker create`\nand `docker network connect` commands.\n",
"example": {
"EndpointsConfig": {
"isolated_nw": {
"IPAMConfig": {
"IPv4Address": "172.20.30.33",
"IPv6Address": "2001:db8:abcd::3033",
"LinkLocalIPs": [
"169.254.34.68",
"fe80::3468"
]
},
"Links": [
"container_1",
"container_2"
],
"Aliases": [
"server_x",
"server_y"
]
}
}
}
},
"NetworkSettings": {
"type": "object",
"properties": {
"Bridge": {
"type": "string",
"description": "Name of the network's bridge (for example, `docker0`).",
"example": "docker0"
},
"SandboxID": {
"type": "string",
"description": "SandboxID uniquely represents a container's network stack.",
"example": "9d12daf2c33f5959c8bf90aa513e4f65b561738661003029ec84830cd503a0c3"
},
"HairpinMode": {
"type": "boolean",
"description": "Indicates if hairpin NAT should be enabled on the virtual interface.\n",
"example": false
},
"LinkLocalIPv6Address": {
"type": "string",
"description": "IPv6 unicast address using the link-local prefix.",
"example": "fe80::42:acff:fe11:1"
},
"LinkLocalIPv6PrefixLen": {
"type": "integer",
"description": "Prefix length of the IPv6 unicast address.",
"example": 64
},
"Ports": {
"$ref": "#/components/schemas/PortMap"
},
"SandboxKey": {
"type": "string",
"description": "SandboxKey identifies the sandbox",
"example": "/var/run/docker/netns/8ab54b426c38"
},
"SecondaryIPAddresses": {
"type": "array",
"description": "",
"nullable": true,
"items": {
"$ref": "#/components/schemas/Address"
}
},
"SecondaryIPv6Addresses": {
"type": "array",
"description": "",
"nullable": true,
"items": {
"$ref": "#/components/schemas/Address"
}
},
"EndpointID": {
"type": "string",
"description": "EndpointID uniquely represents a service endpoint in a Sandbox.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b"
},
"Gateway": {
"type": "string",
"description": "Gateway address for the default \"bridge\" network.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "172.17.0.1"
},
"GlobalIPv6Address": {
"type": "string",
"description": "Global IPv6 address for the default \"bridge\" network.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "2001:db8::5689"
},
"GlobalIPv6PrefixLen": {
"type": "integer",
"description": "Mask length of the global IPv6 address.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": 64
},
"IPAddress": {
"type": "string",
"description": "IPv4 address for the default \"bridge\" network.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "172.17.0.4"
},
"IPPrefixLen": {
"type": "integer",
"description": "Mask length of the IPv4 address.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": 16
},
"IPv6Gateway": {
"type": "string",
"description": "IPv6 gateway address for this network.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "2001:db8:2::100"
},
"MacAddress": {
"type": "string",
"description": "MAC address for the container on the default \"bridge\" network.\n\n<p><br /></p>\n\n> **Deprecated**: This field is only propagated when attached to the\n> default \"bridge\" network. Use the information from the \"bridge\"\n> network inside the `Networks` map instead, which contains the same\n> information. This field was deprecated in Docker 1.9 and is scheduled\n> to be removed in Docker 17.12.0\n",
"example": "02:42:ac:11:00:04"
},
"Networks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EndpointSettings"
},
"description": "Information about all networks that the container is connected to.\n"
}
},
"description": "NetworkSettings exposes the network settings in the API"
},
"Address": {
"type": "object",
"properties": {
"Addr": {
"type": "string",
"description": "IP address."
},
"PrefixLen": {
"type": "integer",
"description": "Mask length of the IP address."
}
},
"description": "Address represents an IPv4 or IPv6 IP address."
},
"PortMap": {
"type": "object",
"additionalProperties": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/PortBinding"
}
},
"description": "PortMap describes the mapping of container ports to host ports, using the\ncontainer's port-number and protocol as key in the format `<port>/<protocol>`,\nfor example, `80/udp`.\n\nIf a container's port is mapped for multiple protocols, separate entries\nare added to the mapping table.\n",
"example": {
"443/tcp": [
{
"HostIp": "127.0.0.1",
"HostPort": "4443"
}
],
"80/tcp": [
{
"HostIp": "0.0.0.0",
"HostPort": "80"
},
{
"HostIp": "0.0.0.0",
"HostPort": "8080"
}
],
"80/udp": [
{
"HostIp": "0.0.0.0",
"HostPort": "80"
}
],
"53/udp": [
{
"HostIp": "0.0.0.0",
"HostPort": "53"
}
]
}
},
"PortBinding": {
"type": "object",
"properties": {
"HostIp": {
"type": "string",
"description": "Host IP address that the container's port is mapped to.",
"example": "127.0.0.1"
},
"HostPort": {
"type": "string",
"description": "Host port number that the container's port is mapped to.",
"example": "4443"
}
},
"description": "PortBinding represents a binding between a host IP address and a host\nport.\n"
},
"GraphDriverData": {
"required": [
"Data",
"Name"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the storage driver.",
"nullable": false,
"example": "overlay2"
},
"Data": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Low-level storage metadata, provided as key/value pairs.\n\nThis information is driver-specific, and depends on the storage-driver\nin use, and should be used for informational purposes only.\n",
"nullable": false,
"example": {
"MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
"UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
"WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
}
}
},
"description": "Information about the storage driver used to store the container's and\nimage's filesystem.\n"
},
"FilesystemChange": {
"required": [
"Kind",
"Path"
],
"type": "object",
"properties": {
"Path": {
"type": "string",
"description": "Path to file or directory that has changed.\n",
"nullable": false
},
"Kind": {
"$ref": "#/components/schemas/ChangeType"
}
},
"description": "Change in the container's filesystem.\n"
},
"ChangeType": {
"type": "integer",
"description": "Kind of change\n\nCan be one of:\n\n- `0`: Modified (\"C\")\n- `1`: Added (\"A\")\n- `2`: Deleted (\"D\")\n",
"format": "uint8",
"nullable": false,
"enum": [
0,
1,
2
],
"x-nullable": false
},
"ImageInspect": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "ID is the content-addressable ID of an image.\n\nThis identifier is a content-addressable digest calculated from the\nimage's configuration (which includes the digests of layers used by\nthe image).\n\nNote that this digest differs from the `RepoDigests` below, which\nholds digests of image manifests that reference the image.\n",
"nullable": false,
"example": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
},
"RepoTags": {
"type": "array",
"description": "List of image names/tags in the local image cache that reference this\nimage.\n\nMultiple image tags can refer to the same image, and this list may be\nempty if no tags reference the image, in which case the image is\n\"untagged\", in which case it can still be referenced by its ID.\n",
"example": [
"example:1.0",
"example:latest",
"example:stable",
"internal.registry.example.com:5000/example:1.0"
],
"items": {
"type": "string"
}
},
"RepoDigests": {
"type": "array",
"description": "List of content-addressable digests of locally available image manifests\nthat the image is referenced from. Multiple manifests can refer to the\nsame image.\n\nThese digests are usually only available if the image was either pulled\nfrom a registry, or if the image was pushed to a registry, which is when\nthe manifest is generated and its digest calculated.\n",
"example": [
"example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
"internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
],
"items": {
"type": "string"
}
},
"Parent": {
"type": "string",
"description": "ID of the parent image.\n\nDepending on how the image was created, this field may be empty and\nis only set for images that were built/created locally. This field\nis empty if the image was pulled from an image registry.\n",
"nullable": false,
"example": ""
},
"Comment": {
"type": "string",
"description": "Optional message that was set when committing or importing the image.\n",
"nullable": false,
"example": ""
},
"Created": {
"type": "string",
"description": "Date and time at which the image was created, formatted in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"nullable": false,
"example": "2022-02-04T21:20:12.497794809Z"
},
"Container": {
"type": "string",
"description": "The ID of the container that was used to create the image.\n\nDepending on how the image was created, this field may be empty.\n",
"nullable": false,
"example": "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
},
"ContainerConfig": {
"$ref": "#/components/schemas/ContainerConfig"
},
"DockerVersion": {
"type": "string",
"description": "The version of Docker that was used to build the image.\n\nDepending on how the image was created, this field may be empty.\n",
"nullable": false,
"example": "20.10.7"
},
"Author": {
"type": "string",
"description": "Name of the author that was specified when committing the image, or as\nspecified through MAINTAINER (deprecated) in the Dockerfile.\n",
"nullable": false,
"example": ""
},
"Config": {
"$ref": "#/components/schemas/ContainerConfig"
},
"Architecture": {
"type": "string",
"description": "Hardware CPU architecture that the image runs on.\n",
"nullable": false,
"example": "arm"
},
"Variant": {
"type": "string",
"description": "CPU architecture variant (presently ARM-only).\n",
"nullable": true,
"example": "v7"
},
"Os": {
"type": "string",
"description": "Operating System the image is built to run on.\n",
"nullable": false,
"example": "linux"
},
"OsVersion": {
"type": "string",
"description": "Operating System version the image is built to run on (especially\nfor Windows).\n",
"nullable": true,
"example": ""
},
"Size": {
"type": "integer",
"description": "Total size of the image including all layers it is composed of.\n",
"format": "int64",
"nullable": false,
"example": 1239828
},
"VirtualSize": {
"type": "integer",
"description": "Total size of the image including all layers it is composed of.\n\nIn versions of Docker before v1.10, this field was calculated from\nthe image itself and all of its parent images. Images are now stored\nself-contained, and no longer use a parent-chain, making this field\nan equivalent of the Size field.\n\n> **Deprecated**: this field is kept for backward compatibility, but\n> will be removed in API v1.44.\n",
"format": "int64",
"example": 1239828
},
"GraphDriver": {
"$ref": "#/components/schemas/GraphDriverData"
},
"RootFS": {
"required": [
"Type"
],
"type": "object",
"properties": {
"Type": {
"type": "string",
"nullable": false,
"example": "layers"
},
"Layers": {
"type": "array",
"example": [
"sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6",
"sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
],
"items": {
"type": "string"
}
}
},
"description": "Information about the image's RootFS, including the layer IDs.\n"
},
"Metadata": {
"type": "object",
"properties": {
"LastTagTime": {
"type": "string",
"description": "Date and time at which the image was last tagged in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n\nThis information is only available if the image was tagged locally,\nand omitted otherwise.\n",
"format": "dateTime",
"nullable": true,
"example": "2022-02-28T14:40:02.623929178Z"
}
},
"description": "Additional metadata of the image in the local cache. This information\nis local to the daemon, and not part of the image itself.\n"
}
},
"description": "Information about an image in the local image cache.\n"
},
"ImageSummary": {
"required": [
"Containers",
"Created",
"Id",
"Labels",
"ParentId",
"RepoDigests",
"RepoTags",
"SharedSize",
"Size"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "ID is the content-addressable ID of an image.\n\nThis identifier is a content-addressable digest calculated from the\nimage's configuration (which includes the digests of layers used by\nthe image).\n\nNote that this digest differs from the `RepoDigests` below, which\nholds digests of image manifests that reference the image.\n",
"nullable": false,
"example": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
},
"ParentId": {
"type": "string",
"description": "ID of the parent image.\n\nDepending on how the image was created, this field may be empty and\nis only set for images that were built/created locally. This field\nis empty if the image was pulled from an image registry.\n",
"nullable": false,
"example": ""
},
"RepoTags": {
"type": "array",
"description": "List of image names/tags in the local image cache that reference this\nimage.\n\nMultiple image tags can refer to the same image, and this list may be\nempty if no tags reference the image, in which case the image is\n\"untagged\", in which case it can still be referenced by its ID.\n",
"nullable": false,
"example": [
"example:1.0",
"example:latest",
"example:stable",
"internal.registry.example.com:5000/example:1.0"
],
"items": {
"type": "string"
}
},
"RepoDigests": {
"type": "array",
"description": "List of content-addressable digests of locally available image manifests\nthat the image is referenced from. Multiple manifests can refer to the\nsame image.\n\nThese digests are usually only available if the image was either pulled\nfrom a registry, or if the image was pushed to a registry, which is when\nthe manifest is generated and its digest calculated.\n",
"nullable": false,
"example": [
"example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
"internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
],
"items": {
"type": "string"
}
},
"Created": {
"type": "integer",
"description": "Date and time at which the image was created as a Unix timestamp\n(number of seconds sinds EPOCH).\n",
"nullable": false,
"example": 1644009612
},
"Size": {
"type": "integer",
"description": "Total size of the image including all layers it is composed of.\n",
"format": "int64",
"nullable": false,
"example": 172064416
},
"SharedSize": {
"type": "integer",
"description": "Total size of image layers that are shared between this image and other\nimages.\n\nThis size is not calculated by default. `-1` indicates that the value\nhas not been set / calculated.\n",
"format": "int64",
"nullable": false,
"example": 1239828
},
"VirtualSize": {
"type": "integer",
"description": "Total size of the image including all layers it is composed of.\n\nIn versions of Docker before v1.10, this field was calculated from\nthe image itself and all of its parent images. Images are now stored\nself-contained, and no longer use a parent-chain, making this field\nan equivalent of the Size field.\n\nDeprecated: this field is kept for backward compatibility, and will be removed in API v1.44.",
"format": "int64",
"example": 172064416
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"nullable": false,
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
},
"Containers": {
"type": "integer",
"description": "Number of containers using this image. Includes both stopped and running\ncontainers.\n\nThis size is not calculated by default, and depends on which API endpoint\nis used. `-1` indicates that the value has not been set / calculated.\n",
"nullable": false,
"example": 2
}
}
},
"AuthConfig": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"email": {
"type": "string"
},
"serveraddress": {
"type": "string"
}
},
"example": {
"username": "hannibal",
"password": "xxxx",
"serveraddress": "https://index.docker.io/v1/"
}
},
"ProcessConfig": {
"type": "object",
"properties": {
"privileged": {
"type": "boolean"
},
"user": {
"type": "string"
},
"tty": {
"type": "boolean"
},
"entrypoint": {
"type": "string"
},
"arguments": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Volume": {
"required": [
"Driver",
"Labels",
"Mountpoint",
"Name",
"Options",
"Scope"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the volume.",
"nullable": false,
"example": "tardis"
},
"Driver": {
"type": "string",
"description": "Name of the volume driver used by the volume.",
"nullable": false,
"example": "custom"
},
"Mountpoint": {
"type": "string",
"description": "Mount path of the volume on the host.",
"nullable": false,
"example": "/var/lib/docker/volumes/tardis"
},
"CreatedAt": {
"type": "string",
"description": "Date/Time the volume was created.",
"format": "dateTime",
"example": "2016-06-07T20:31:11.853781916Z"
},
"Status": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
},
"description": "Low-level details about the volume, provided by the volume driver.\nDetails are returned as a map with key/value pairs:\n`{\"key\":\"value\",\"key2\":\"value2\"}`.\n\nThe `Status` field is optional, and is omitted if the volume driver\ndoes not support this feature.\n",
"example": {
"hello": "world"
}
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"nullable": false,
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
},
"Scope": {
"type": "string",
"description": "The level at which the volume exists. Either `global` for cluster-wide,\nor `local` for machine level.\n",
"nullable": false,
"example": "local",
"default": "local",
"enum": [
"local",
"global"
]
},
"ClusterVolume": {
"$ref": "#/components/schemas/ClusterVolume"
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The driver specific options used when creating the volume.\n",
"example": {
"device": "tmpfs",
"o": "size=100m,uid=1000",
"type": "tmpfs"
}
},
"UsageData": {
"required": [
"RefCount",
"Size"
],
"type": "object",
"properties": {
"Size": {
"type": "integer",
"description": "Amount of disk space used by the volume (in bytes). This information\nis only available for volumes created with the `\"local\"` volume\ndriver. For volumes created with other volume drivers, this field\nis set to `-1` (\"not available\")\n",
"format": "int64",
"nullable": false,
"default": -1
},
"RefCount": {
"type": "integer",
"description": "The number of containers referencing this volume. This field\nis set to `-1` if the reference-count is not available.\n",
"format": "int64",
"nullable": false,
"default": -1
}
},
"description": "Usage details about the volume. This information is used by the\n`GET /system/df` endpoint, and omitted in other endpoints.\n",
"nullable": true,
"x-go-name": "UsageData"
}
}
},
"VolumeCreateOptions": {
"title": "VolumeConfig",
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The new volume's name. If not specified, Docker generates a name.\n",
"nullable": false,
"example": "tardis"
},
"Driver": {
"type": "string",
"description": "Name of the volume driver to use.",
"nullable": false,
"example": "custom",
"default": "local"
},
"DriverOpts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A mapping of driver options and values. These options are\npassed directly to the driver and are driver specific.\n",
"example": {
"device": "tmpfs",
"o": "size=100m,uid=1000",
"type": "tmpfs"
}
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
},
"ClusterVolumeSpec": {
"$ref": "#/components/schemas/ClusterVolumeSpec"
}
},
"description": "Volume configuration",
"x-go-name": "CreateOptions"
},
"VolumeListResponse": {
"title": "VolumeListResponse",
"type": "object",
"properties": {
"Volumes": {
"type": "array",
"description": "List of volumes",
"items": {
"$ref": "#/components/schemas/Volume"
}
},
"Warnings": {
"type": "array",
"description": "Warnings that occurred when fetching the list of volumes.\n",
"example": [],
"items": {
"type": "string"
}
}
},
"description": "Volume list response",
"x-go-name": "ListResponse"
},
"Network": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Id": {
"type": "string"
},
"Created": {
"type": "string",
"format": "dateTime"
},
"Scope": {
"type": "string"
},
"Driver": {
"type": "string"
},
"EnableIPv6": {
"type": "boolean"
},
"IPAM": {
"$ref": "#/components/schemas/IPAM"
},
"Internal": {
"type": "boolean"
},
"Attachable": {
"type": "boolean"
},
"Ingress": {
"type": "boolean"
},
"Containers": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/NetworkContainer"
}
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"Name": "net01",
"Id": "7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
"Created": "2016-10-19T04:33:30.360899459Z",
"Scope": "local",
"Driver": "bridge",
"EnableIPv6": false,
"IPAM": {
"Driver": "default",
"Config": [
{
"Subnet": "172.19.0.0/16",
"Gateway": "172.19.0.1"
}
],
"Options": {
"foo": "bar"
}
},
"Internal": false,
"Attachable": false,
"Ingress": false,
"Containers": {
"19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c": {
"Name": "test",
"EndpointID": "628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a",
"MacAddress": "02:42:ac:13:00:02",
"IPv4Address": "172.19.0.2/16",
"IPv6Address": ""
}
},
"Options": {
"com.docker.network.bridge.default_bridge": "true",
"com.docker.network.bridge.enable_icc": "true",
"com.docker.network.bridge.enable_ip_masquerade": "true",
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
"com.docker.network.bridge.name": "docker0",
"com.docker.network.driver.mtu": "1500"
},
"Labels": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
}
},
"IPAM": {
"type": "object",
"properties": {
"Driver": {
"type": "string",
"description": "Name of the IPAM driver to use.",
"default": "default"
},
"Config": {
"type": "array",
"description": "List of IPAM configuration options, specified as a map:\n\n```\n{\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>}\n```\n",
"items": {
"$ref": "#/components/schemas/IPAMConfig"
}
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Driver-specific options, specified as a map."
}
}
},
"IPAMConfig": {
"type": "object",
"properties": {
"Subnet": {
"type": "string"
},
"IPRange": {
"type": "string"
},
"Gateway": {
"type": "string"
},
"AuxiliaryAddresses": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"NetworkContainer": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"EndpointID": {
"type": "string"
},
"MacAddress": {
"type": "string"
},
"IPv4Address": {
"type": "string"
},
"IPv6Address": {
"type": "string"
}
}
},
"BuildInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"stream": {
"type": "string"
},
"error": {
"type": "string"
},
"errorDetail": {
"$ref": "#/components/schemas/ErrorDetail"
},
"status": {
"type": "string"
},
"progress": {
"type": "string"
},
"progressDetail": {
"$ref": "#/components/schemas/ProgressDetail"
},
"aux": {
"$ref": "#/components/schemas/ImageID"
}
}
},
"BuildCache": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "Unique ID of the build cache record.\n",
"example": "ndlpt0hhvkqcdfkputsk4cq9c"
},
"Parent": {
"type": "string",
"description": "ID of the parent build cache record.\n\n> **Deprecated**: This field is deprecated, and omitted if empty.\n",
"nullable": true,
"example": ""
},
"Parents": {
"type": "array",
"description": "List of parent build cache record IDs.\n",
"nullable": true,
"example": [
"hw53o5aio51xtltp5xjp8v7fx"
],
"items": {
"type": "string"
}
},
"Type": {
"type": "string",
"description": "Cache record type.\n",
"example": "regular",
"enum": [
"internal",
"frontend",
"source.local",
"source.git.checkout",
"exec.cachemount",
"regular"
]
},
"Description": {
"type": "string",
"description": "Description of the build-step that produced the build cache.\n",
"example": "mount / from exec /bin/sh -c echo 'Binary::apt::APT::Keep-Downloaded-Packages \"true\";' > /etc/apt/apt.conf.d/keep-cache"
},
"InUse": {
"type": "boolean",
"description": "Indicates if the build cache is in use.\n",
"example": false
},
"Shared": {
"type": "boolean",
"description": "Indicates if the build cache is shared.\n",
"example": true
},
"Size": {
"type": "integer",
"description": "Amount of disk space used by the build cache (in bytes).\n",
"example": 51
},
"CreatedAt": {
"type": "string",
"description": "Date and time at which the build cache was created in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2016-08-18T10:44:24.496525531Z"
},
"LastUsedAt": {
"type": "string",
"description": "Date and time at which the build cache was last used in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"nullable": true,
"example": "2017-08-09T07:09:37.632105588Z"
},
"UsageCount": {
"type": "integer",
"example": 26
}
},
"description": "BuildCache contains information about a build cache record.\n"
},
"ImageID": {
"type": "object",
"properties": {
"ID": {
"type": "string"
}
},
"description": "Image ID or Digest",
"example": {
"ID": "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"
}
},
"CreateImageInfo": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"error": {
"type": "string"
},
"errorDetail": {
"$ref": "#/components/schemas/ErrorDetail"
},
"status": {
"type": "string"
},
"progress": {
"type": "string"
},
"progressDetail": {
"$ref": "#/components/schemas/ProgressDetail"
}
}
},
"PushImageInfo": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
},
"progress": {
"type": "string"
},
"progressDetail": {
"$ref": "#/components/schemas/ProgressDetail"
}
}
},
"ErrorDetail": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
}
}
},
"ProgressDetail": {
"type": "object",
"properties": {
"current": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"ErrorResponse": {
"required": [
"message"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The error message.",
"nullable": false
}
},
"description": "Represents an error.",
"example": {
"message": "Something went wrong."
}
},
"IdResponse": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The id of the newly created object.",
"nullable": false
}
},
"description": "Response to an API call that returns just an Id"
},
"EndpointSettings": {
"type": "object",
"properties": {
"IPAMConfig": {
"$ref": "#/components/schemas/EndpointIPAMConfig"
},
"Links": {
"type": "array",
"example": [
"container_1",
"container_2"
],
"items": {
"type": "string"
}
},
"Aliases": {
"type": "array",
"example": [
"server_x",
"server_y"
],
"items": {
"type": "string"
}
},
"NetworkID": {
"type": "string",
"description": "Unique ID of the network.\n",
"example": "08754567f1f40222263eab4102e1c733ae697e8e354aa9cd6e18d7402835292a"
},
"EndpointID": {
"type": "string",
"description": "Unique ID for the service endpoint in a Sandbox.\n",
"example": "b88f5b905aabf2893f3cbc4ee42d1ea7980bbc0a92e2c8922b1e1795298afb0b"
},
"Gateway": {
"type": "string",
"description": "Gateway address for this network.\n",
"example": "172.17.0.1"
},
"IPAddress": {
"type": "string",
"description": "IPv4 address.\n",
"example": "172.17.0.4"
},
"IPPrefixLen": {
"type": "integer",
"description": "Mask length of the IPv4 address.\n",
"example": 16
},
"IPv6Gateway": {
"type": "string",
"description": "IPv6 gateway address.\n",
"example": "2001:db8:2::100"
},
"GlobalIPv6Address": {
"type": "string",
"description": "Global IPv6 address.\n",
"example": "2001:db8::5689"
},
"GlobalIPv6PrefixLen": {
"type": "integer",
"description": "Mask length of the global IPv6 address.\n",
"format": "int64",
"example": 64
},
"MacAddress": {
"type": "string",
"description": "MAC address for the endpoint on this network.\n",
"example": "02:42:ac:11:00:04"
},
"DriverOpts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "DriverOpts is a mapping of driver options and values. These options\nare passed directly to the driver and are driver specific.\n",
"nullable": true,
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
}
},
"description": "Configuration for a network endpoint."
},
"EndpointIPAMConfig": {
"type": "object",
"properties": {
"IPv4Address": {
"type": "string",
"example": "172.20.30.33"
},
"IPv6Address": {
"type": "string",
"example": "2001:db8:abcd::3033"
},
"LinkLocalIPs": {
"type": "array",
"example": [
"169.254.34.68",
"fe80::3468"
],
"items": {
"type": "string"
}
}
},
"description": "EndpointIPAMConfig represents an endpoint's IPAM configuration.\n",
"nullable": true,
"x-nullable": true
},
"PluginMount": {
"required": [
"Description",
"Destination",
"Name",
"Options",
"Settable",
"Source",
"Type"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": false,
"example": "some-mount"
},
"Description": {
"type": "string",
"nullable": false,
"example": "This is a mount that's used by the plugin."
},
"Settable": {
"type": "array",
"items": {
"type": "string"
}
},
"Source": {
"type": "string",
"example": "/var/lib/docker/plugins/"
},
"Destination": {
"type": "string",
"nullable": false,
"example": "/mnt/state"
},
"Type": {
"type": "string",
"nullable": false,
"example": "bind"
},
"Options": {
"type": "array",
"example": [
"rbind",
"rw"
],
"items": {
"type": "string"
}
}
},
"nullable": false,
"x-nullable": false
},
"PluginDevice": {
"required": [
"Description",
"Name",
"Path",
"Settable"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": false
},
"Description": {
"type": "string",
"nullable": false
},
"Settable": {
"type": "array",
"items": {
"type": "string"
}
},
"Path": {
"type": "string",
"example": "/dev/fuse"
}
},
"nullable": false,
"x-nullable": false
},
"PluginEnv": {
"required": [
"Description",
"Name",
"Settable",
"Value"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": false
},
"Description": {
"type": "string",
"nullable": false
},
"Settable": {
"type": "array",
"items": {
"type": "string"
}
},
"Value": {
"type": "string"
}
},
"nullable": false,
"x-nullable": false
},
"PluginInterfaceType": {
"required": [
"Capability",
"Prefix",
"Version"
],
"type": "object",
"properties": {
"Prefix": {
"type": "string",
"nullable": false
},
"Capability": {
"type": "string",
"nullable": false
},
"Version": {
"type": "string",
"nullable": false
}
},
"nullable": false,
"x-nullable": false
},
"PluginPrivilege": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"example": "network"
},
"Description": {
"type": "string"
},
"Value": {
"type": "array",
"example": [
"host"
],
"items": {
"type": "string"
}
}
},
"description": "Describes a permission the user has to accept upon installing\nthe plugin.\n",
"x-go-name": "PluginPrivilege"
},
"Plugin": {
"required": [
"Config",
"Enabled",
"Name",
"Settings"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"example": "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
},
"Name": {
"type": "string",
"nullable": false,
"example": "tiborvass/sample-volume-plugin"
},
"Enabled": {
"type": "boolean",
"description": "True if the plugin is running. False if the plugin is not running, only installed.",
"nullable": false,
"example": true
},
"Settings": {
"required": [
"Args",
"Devices",
"Env",
"Mounts"
],
"type": "object",
"properties": {
"Mounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginMount"
}
},
"Env": {
"type": "array",
"example": [
"DEBUG=0"
],
"items": {
"type": "string"
}
},
"Args": {
"type": "array",
"items": {
"type": "string"
}
},
"Devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginDevice"
}
}
},
"description": "Settings that can be modified by users.",
"nullable": false
},
"PluginReference": {
"type": "string",
"description": "plugin remote reference used to push/pull the plugin",
"nullable": false,
"example": "localhost:5000/tiborvass/sample-volume-plugin:latest"
},
"Config": {
"required": [
"Args",
"Description",
"Documentation",
"Entrypoint",
"Env",
"Interface",
"IpcHost",
"Linux",
"Mounts",
"Network",
"PidHost",
"PropagatedMount",
"WorkDir"
],
"type": "object",
"properties": {
"DockerVersion": {
"type": "string",
"description": "Docker Version used to create the plugin",
"nullable": false,
"example": "17.06.0-ce"
},
"Description": {
"type": "string",
"nullable": false,
"example": "A sample volume plugin for Docker"
},
"Documentation": {
"type": "string",
"nullable": false,
"example": "https://docs.docker.com/engine/extend/plugins/"
},
"Interface": {
"required": [
"Socket",
"Types"
],
"type": "object",
"properties": {
"Types": {
"type": "array",
"example": [
"docker.volumedriver/1.0"
],
"items": {
"$ref": "#/components/schemas/PluginInterfaceType"
}
},
"Socket": {
"type": "string",
"nullable": false,
"example": "plugins.sock"
},
"ProtocolScheme": {
"type": "string",
"description": "Protocol to use for clients connecting to the plugin.",
"example": "some.protocol/v1.0",
"enum": [
"",
"moby.plugins.http/v1"
]
}
},
"description": "The interface between Docker and the plugin",
"nullable": false
},
"Entrypoint": {
"type": "array",
"example": [
"/usr/bin/sample-volume-plugin",
"/data"
],
"items": {
"type": "string"
}
},
"WorkDir": {
"type": "string",
"nullable": false,
"example": "/bin/"
},
"User": {
"type": "object",
"properties": {
"UID": {
"type": "integer",
"format": "uint32",
"example": 1000
},
"GID": {
"type": "integer",
"format": "uint32",
"example": 1000
}
},
"nullable": false
},
"Network": {
"required": [
"Type"
],
"type": "object",
"properties": {
"Type": {
"type": "string",
"nullable": false,
"example": "host"
}
},
"nullable": false
},
"Linux": {
"required": [
"AllowAllDevices",
"Capabilities",
"Devices"
],
"type": "object",
"properties": {
"Capabilities": {
"type": "array",
"example": [
"CAP_SYS_ADMIN",
"CAP_SYSLOG"
],
"items": {
"type": "string"
}
},
"AllowAllDevices": {
"type": "boolean",
"nullable": false,
"example": false
},
"Devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginDevice"
}
}
},
"nullable": false
},
"PropagatedMount": {
"type": "string",
"nullable": false,
"example": "/mnt/volumes"
},
"IpcHost": {
"type": "boolean",
"nullable": false,
"example": false
},
"PidHost": {
"type": "boolean",
"nullable": false,
"example": false
},
"Mounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginMount"
}
},
"Env": {
"type": "array",
"example": [
{
"Name": "DEBUG",
"Description": "If set, prints debug messages",
"Value": "0"
}
],
"items": {
"$ref": "#/components/schemas/PluginEnv"
}
},
"Args": {
"required": [
"Description",
"Name",
"Settable",
"Value"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": false,
"example": "args"
},
"Description": {
"type": "string",
"nullable": false,
"example": "command line arguments"
},
"Settable": {
"type": "array",
"items": {
"type": "string"
}
},
"Value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"nullable": false
},
"rootfs": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "layers"
},
"diff_ids": {
"type": "array",
"example": [
"sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
"sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
],
"items": {
"type": "string"
}
}
}
}
},
"description": "The config of a plugin.",
"nullable": false
}
},
"description": "A plugin for the Engine API"
},
"ObjectVersion": {
"type": "object",
"properties": {
"Index": {
"type": "integer",
"format": "uint64",
"example": 373531
}
},
"description": "The version number of the object such as node, service, etc. This is needed\nto avoid conflicting writes. The client must send the version number along\nwith the modified specification when updating these objects.\n\nThis approach ensures safe concurrency and determinism in that the change\non the object may not be applied if the version number has changed from the\nlast read. In other words, if two update requests specify the same base\nversion, only one of the requests can succeed. As a result, two separate\nupdate requests that happen at the same time will not unintentionally\noverwrite each other.\n"
},
"NodeSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name for the node.",
"example": "my-node"
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"Role": {
"type": "string",
"description": "Role of the node.",
"example": "manager",
"enum": [
"worker",
"manager"
]
},
"Availability": {
"type": "string",
"description": "Availability of the node.",
"example": "active",
"enum": [
"active",
"pause",
"drain"
]
}
},
"example": {
"Availability": "active",
"Name": "node-name",
"Role": "manager",
"Labels": {
"foo": "bar"
}
}
},
"Node": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"example": "24ifsmvkjbyhk"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"description": "Date and time at which the node was added to the swarm in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2016-08-18T10:44:24.496525531Z"
},
"UpdatedAt": {
"type": "string",
"description": "Date and time at which the node was last updated in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2017-08-09T07:09:37.632105588Z"
},
"Spec": {
"$ref": "#/components/schemas/NodeSpec"
},
"Description": {
"$ref": "#/components/schemas/NodeDescription"
},
"Status": {
"$ref": "#/components/schemas/NodeStatus"
},
"ManagerStatus": {
"$ref": "#/components/schemas/ManagerStatus"
}
}
},
"NodeDescription": {
"type": "object",
"properties": {
"Hostname": {
"type": "string",
"example": "bf3067039e47"
},
"Platform": {
"$ref": "#/components/schemas/Platform"
},
"Resources": {
"$ref": "#/components/schemas/ResourceObject"
},
"Engine": {
"$ref": "#/components/schemas/EngineDescription"
},
"TLSInfo": {
"$ref": "#/components/schemas/TLSInfo"
}
},
"description": "NodeDescription encapsulates the properties of the Node as reported by the\nagent.\n"
},
"Platform": {
"type": "object",
"properties": {
"Architecture": {
"type": "string",
"description": "Architecture represents the hardware architecture (for example,\n`x86_64`).\n",
"example": "x86_64"
},
"OS": {
"type": "string",
"description": "OS represents the Operating System (for example, `linux` or `windows`).\n",
"example": "linux"
}
},
"description": "Platform represents the platform (Arch/OS).\n"
},
"EngineDescription": {
"type": "object",
"properties": {
"EngineVersion": {
"type": "string",
"example": "17.06.0"
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {
"foo": "bar"
}
},
"Plugins": {
"type": "array",
"example": [
{
"Type": "Log",
"Name": "awslogs"
},
{
"Type": "Log",
"Name": "fluentd"
},
{
"Type": "Log",
"Name": "gcplogs"
},
{
"Type": "Log",
"Name": "gelf"
},
{
"Type": "Log",
"Name": "journald"
},
{
"Type": "Log",
"Name": "json-file"
},
{
"Type": "Log",
"Name": "logentries"
},
{
"Type": "Log",
"Name": "splunk"
},
{
"Type": "Log",
"Name": "syslog"
},
{
"Type": "Network",
"Name": "bridge"
},
{
"Type": "Network",
"Name": "host"
},
{
"Type": "Network",
"Name": "ipvlan"
},
{
"Type": "Network",
"Name": "macvlan"
},
{
"Type": "Network",
"Name": "null"
},
{
"Type": "Network",
"Name": "overlay"
},
{
"Type": "Volume",
"Name": "local"
},
{
"Type": "Volume",
"Name": "localhost:5000/vieux/sshfs:latest"
},
{
"Type": "Volume",
"Name": "vieux/sshfs:latest"
}
],
"items": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
}
},
"description": "EngineDescription provides information about an engine."
},
"TLSInfo": {
"type": "object",
"properties": {
"TrustRoot": {
"type": "string",
"description": "The root CA certificate(s) that are used to validate leaf TLS\ncertificates.\n"
},
"CertIssuerSubject": {
"type": "string",
"description": "The base64-url-safe-encoded raw subject bytes of the issuer."
},
"CertIssuerPublicKey": {
"type": "string",
"description": "The base64-url-safe-encoded raw public key bytes of the issuer.\n"
}
},
"description": "Information about the issuer of leaf TLS certificates and the trusted root\nCA certificate.\n",
"example": {
"TrustRoot": "-----BEGIN CERTIFICATE-----\nMIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0\nMzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf\n3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO\nPQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz\npxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H\n-----END CERTIFICATE-----\n",
"CertIssuerSubject": "MBMxETAPBgNVBAMTCHN3YXJtLWNh",
"CertIssuerPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A=="
}
},
"NodeStatus": {
"type": "object",
"properties": {
"State": {
"$ref": "#/components/schemas/NodeState"
},
"Message": {
"type": "string",
"example": ""
},
"Addr": {
"type": "string",
"description": "IP address of the node.",
"example": "172.17.0.2"
}
},
"description": "NodeStatus represents the status of a node.\n\nIt provides the current status of the node, as seen by the manager.\n"
},
"NodeState": {
"type": "string",
"description": "NodeState represents the state of a node.",
"example": "ready",
"enum": [
"unknown",
"down",
"ready",
"disconnected"
]
},
"ManagerStatus": {
"type": "object",
"properties": {
"Leader": {
"type": "boolean",
"example": true,
"default": false
},
"Reachability": {
"$ref": "#/components/schemas/Reachability"
},
"Addr": {
"type": "string",
"description": "The IP address and port at which the manager is reachable.\n",
"example": "10.0.0.46:2377"
}
},
"description": "ManagerStatus represents the status of a manager.\n\nIt provides the current status of a node's manager component, if the node\nis a manager.\n",
"nullable": true,
"x-nullable": true
},
"Reachability": {
"type": "string",
"description": "Reachability represents the reachability of a node.",
"example": "reachable",
"enum": [
"unknown",
"unreachable",
"reachable"
]
},
"SwarmSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the swarm.",
"example": "default"
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.corp.type": "production",
"com.example.corp.department": "engineering"
}
},
"Orchestration": {
"type": "object",
"properties": {
"TaskHistoryRetentionLimit": {
"type": "integer",
"description": "The number of historic tasks to keep per instance or node. If\nnegative, never remove completed or failed tasks.\n",
"format": "int64",
"example": 10
}
},
"description": "Orchestration configuration.",
"nullable": true
},
"Raft": {
"type": "object",
"properties": {
"SnapshotInterval": {
"type": "integer",
"description": "The number of log entries between snapshots.",
"format": "uint64",
"example": 10000
},
"KeepOldSnapshots": {
"type": "integer",
"description": "The number of snapshots to keep beyond the current snapshot.\n",
"format": "uint64"
},
"LogEntriesForSlowFollowers": {
"type": "integer",
"description": "The number of log entries to keep around to sync up slow followers\nafter a snapshot is created.\n",
"format": "uint64",
"example": 500
},
"ElectionTick": {
"type": "integer",
"description": "The number of ticks that a follower will wait for a message from\nthe leader before becoming a candidate and starting an election.\n`ElectionTick` must be greater than `HeartbeatTick`.\n\nA tick currently defaults to one second, so these translate\ndirectly to seconds currently, but this is NOT guaranteed.\n",
"example": 3
},
"HeartbeatTick": {
"type": "integer",
"description": "The number of ticks between heartbeats. Every HeartbeatTick ticks,\nthe leader will send a heartbeat to the followers.\n\nA tick currently defaults to one second, so these translate\ndirectly to seconds currently, but this is NOT guaranteed.\n",
"example": 1
}
},
"description": "Raft configuration."
},
"Dispatcher": {
"type": "object",
"properties": {
"HeartbeatPeriod": {
"type": "integer",
"description": "The delay for an agent to send a heartbeat to the dispatcher.\n",
"format": "int64",
"example": 5000000000
}
},
"description": "Dispatcher configuration.",
"nullable": true
},
"CAConfig": {
"type": "object",
"properties": {
"NodeCertExpiry": {
"type": "integer",
"description": "The duration node certificates are issued for.",
"format": "int64",
"example": 7776000000000000
},
"ExternalCAs": {
"type": "array",
"description": "Configuration for forwarding signing requests to an external\ncertificate authority.\n",
"items": {
"type": "object",
"properties": {
"Protocol": {
"type": "string",
"description": "Protocol for communication with the external CA (currently\nonly `cfssl` is supported).\n",
"default": "cfssl",
"enum": [
"cfssl"
]
},
"URL": {
"type": "string",
"description": "URL where certificate signing requests should be sent.\n"
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "An object with key/value pairs that are interpreted as\nprotocol-specific options for the external CA driver.\n"
},
"CACert": {
"type": "string",
"description": "The root CA certificate (in PEM format) this external CA uses\nto issue TLS certificates (assumed to be to the current swarm\nroot CA certificate if not provided).\n"
}
}
}
},
"SigningCACert": {
"type": "string",
"description": "The desired signing CA certificate for all swarm node TLS leaf\ncertificates, in PEM format.\n"
},
"SigningCAKey": {
"type": "string",
"description": "The desired signing CA key for all swarm node TLS leaf certificates,\nin PEM format.\n"
},
"ForceRotate": {
"type": "integer",
"description": "An integer whose purpose is to force swarm to generate a new\nsigning CA certificate and key, if none have been specified in\n`SigningCACert` and `SigningCAKey`\n",
"format": "uint64"
}
},
"description": "CA configuration.",
"nullable": true
},
"EncryptionConfig": {
"type": "object",
"properties": {
"AutoLockManagers": {
"type": "boolean",
"description": "If set, generate a key and use it to lock data stored on the\nmanagers.\n",
"example": false
}
},
"description": "Parameters related to encryption-at-rest."
},
"TaskDefaults": {
"type": "object",
"properties": {
"LogDriver": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The log driver to use as a default for new tasks.\n",
"example": "json-file"
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Driver-specific options for the selectd log driver, specified\nas key/value pairs.\n",
"example": {
"max-file": "10",
"max-size": "100m"
}
}
},
"description": "The log driver to use for tasks created in the orchestrator if\nunspecified by a service.\n\nUpdating this value only affects new tasks. Existing tasks continue\nto use their previously configured log driver until recreated.\n"
}
},
"description": "Defaults for creating tasks in this cluster."
}
},
"description": "User modifiable swarm configuration."
},
"ClusterInfo": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "The ID of the swarm.",
"example": "abajmipo7b4xz5ip2nrla6b11"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"description": "Date and time at which the swarm was initialised in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2016-08-18T10:44:24.496525531Z"
},
"UpdatedAt": {
"type": "string",
"description": "Date and time at which the swarm was last updated in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
"format": "dateTime",
"example": "2017-08-09T07:09:37.632105588Z"
},
"Spec": {
"$ref": "#/components/schemas/SwarmSpec"
},
"TLSInfo": {
"$ref": "#/components/schemas/TLSInfo"
},
"RootRotationInProgress": {
"type": "boolean",
"description": "Whether there is currently a root CA rotation in progress for the swarm\n",
"example": false
},
"DataPathPort": {
"type": "integer",
"description": "DataPathPort specifies the data path port number for data traffic.\nAcceptable port range is 1024 to 49151.\nIf no port is set or is set to 0, the default port (4789) is used.\n",
"format": "uint32",
"example": 4789
},
"DefaultAddrPool": {
"type": "array",
"description": "Default Address Pool specifies default subnet pools for global scope\nnetworks.\n",
"items": {
"type": "string",
"format": "CIDR",
"example": ""
}
},
"SubnetSize": {
"maximum": 29,
"type": "integer",
"description": "SubnetSize specifies the subnet size of the networks created from the\ndefault subnet pool.\n",
"format": "uint32",
"example": 24
}
},
"description": "ClusterInfo represents information about the swarm as is returned by the\n\"/info\" endpoint. Join-tokens are not included.\n",
"nullable": true,
"x-nullable": true
},
"JoinTokens": {
"type": "object",
"properties": {
"Worker": {
"type": "string",
"description": "The token workers can use to join the swarm.\n",
"example": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx"
},
"Manager": {
"type": "string",
"description": "The token managers can use to join the swarm.\n",
"example": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
}
},
"description": "JoinTokens contains the tokens workers and managers need to join the swarm.\n"
},
"Swarm": {
"allOf": [
{
"$ref": "#/components/schemas/ClusterInfo"
},
{
"type": "object",
"properties": {
"JoinTokens": {
"$ref": "#/components/schemas/JoinTokens"
}
}
}
]
},
"TaskSpec": {
"type": "object",
"properties": {
"PluginSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The name or 'alias' to use for the plugin."
},
"Remote": {
"type": "string",
"description": "The plugin image reference to use."
},
"Disabled": {
"type": "boolean",
"description": "Disable the plugin once scheduled."
},
"PluginPrivilege": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginPrivilege"
}
}
},
"description": "Plugin spec for the service. *(Experimental release only.)*\n\n<p><br /></p>\n\n> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are\n> mutually exclusive. PluginSpec is only used when the Runtime field\n> is set to `plugin`. NetworkAttachmentSpec is used when the Runtime\n> field is set to `attachment`.\n"
},
"ContainerSpec": {
"type": "object",
"properties": {
"Image": {
"type": "string",
"description": "The image name to use for the container"
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value data."
},
"Command": {
"type": "array",
"description": "The command to be run in the image.",
"items": {
"type": "string"
}
},
"Args": {
"type": "array",
"description": "Arguments to the command.",
"items": {
"type": "string"
}
},
"Hostname": {
"type": "string",
"description": "The hostname to use for the container, as a valid\n[RFC 1123](https://tools.ietf.org/html/rfc1123) hostname.\n"
},
"Env": {
"type": "array",
"description": "A list of environment variables in the form `VAR=value`.\n",
"items": {
"type": "string"
}
},
"Dir": {
"type": "string",
"description": "The working directory for commands to run in."
},
"User": {
"type": "string",
"description": "The user inside the container."
},
"Groups": {
"type": "array",
"description": "A list of additional groups that the container process will run as.\n",
"items": {
"type": "string"
}
},
"Privileges": {
"type": "object",
"properties": {
"CredentialSpec": {
"type": "object",
"properties": {
"Config": {
"type": "string",
"description": "Load credential spec from a Swarm Config with the given ID.\nThe specified config must also be present in the Configs\nfield with the Runtime property set.\n\n<p><br /></p>\n\n\n> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,\n> and `CredentialSpec.Config` are mutually exclusive.\n",
"example": "0bt9dmxjvjiqermk6xrop3ekq"
},
"File": {
"type": "string",
"description": "Load credential spec from this file. The file is read by\nthe daemon, and must be present in the `CredentialSpecs`\nsubdirectory in the docker data directory, which defaults\nto `C:\\ProgramData\\Docker\\` on Windows.\n\nFor example, specifying `spec.json` loads\n`C:\\ProgramData\\Docker\\CredentialSpecs\\spec.json`.\n\n<p><br /></p>\n\n> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,\n> and `CredentialSpec.Config` are mutually exclusive.\n",
"example": "spec.json"
},
"Registry": {
"type": "string",
"description": "Load credential spec from this value in the Windows\nregistry. The specified registry value must be located in:\n\n`HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Virtualization\\Containers\\CredentialSpecs`\n\n<p><br /></p>\n\n\n> **Note**: `CredentialSpec.File`, `CredentialSpec.Registry`,\n> and `CredentialSpec.Config` are mutually exclusive.\n"
}
},
"description": "CredentialSpec for managed service account (Windows only)"
},
"SELinuxContext": {
"type": "object",
"properties": {
"Disable": {
"type": "boolean",
"description": "Disable SELinux"
},
"User": {
"type": "string",
"description": "SELinux user label"
},
"Role": {
"type": "string",
"description": "SELinux role label"
},
"Type": {
"type": "string",
"description": "SELinux type label"
},
"Level": {
"type": "string",
"description": "SELinux level label"
}
},
"description": "SELinux labels of the container"
}
},
"description": "Security options for the container"
},
"TTY": {
"type": "boolean",
"description": "Whether a pseudo-TTY should be allocated."
},
"OpenStdin": {
"type": "boolean",
"description": "Open `stdin`"
},
"ReadOnly": {
"type": "boolean",
"description": "Mount the container's root filesystem as read only."
},
"Mounts": {
"type": "array",
"description": "Specification for mounts to be added to containers created as part\nof the service.\n",
"items": {
"$ref": "#/components/schemas/Mount"
}
},
"StopSignal": {
"type": "string",
"description": "Signal to stop the container."
},
"StopGracePeriod": {
"type": "integer",
"description": "Amount of time to wait for the container to terminate before\nforcefully killing it.\n",
"format": "int64"
},
"HealthCheck": {
"$ref": "#/components/schemas/HealthConfig"
},
"Hosts": {
"type": "array",
"description": "A list of hostname/IP mappings to add to the container's `hosts`\nfile. The format of extra hosts is specified in the\n[hosts(5)](http://man7.org/linux/man-pages/man5/hosts.5.html)\nman page:\n\n IP_address canonical_hostname [aliases...]\n",
"items": {
"type": "string"
}
},
"DNSConfig": {
"type": "object",
"properties": {
"Nameservers": {
"type": "array",
"description": "The IP addresses of the name servers.",
"items": {
"type": "string"
}
},
"Search": {
"type": "array",
"description": "A search list for host-name lookup.",
"items": {
"type": "string"
}
},
"Options": {
"type": "array",
"description": "A list of internal resolver variables to be modified (e.g.,\n`debug`, `ndots:3`, etc.).\n",
"items": {
"type": "string"
}
}
},
"description": "Specification for DNS related configurations in resolver configuration\nfile (`resolv.conf`).\n"
},
"Secrets": {
"type": "array",
"description": "Secrets contains references to zero or more secrets that will be\nexposed to the service.\n",
"items": {
"type": "object",
"properties": {
"File": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name represents the final filename in the filesystem.\n"
},
"UID": {
"type": "string",
"description": "UID represents the file UID."
},
"GID": {
"type": "string",
"description": "GID represents the file GID."
},
"Mode": {
"type": "integer",
"description": "Mode represents the FileMode of the file.",
"format": "uint32"
}
},
"description": "File represents a specific target that is backed by a file.\n"
},
"SecretID": {
"type": "string",
"description": "SecretID represents the ID of the specific secret that we're\nreferencing.\n"
},
"SecretName": {
"type": "string",
"description": "SecretName is the name of the secret that this references,\nbut this is just provided for lookup/display purposes. The\nsecret in the reference will be identified by its ID.\n"
}
}
}
},
"Configs": {
"type": "array",
"description": "Configs contains references to zero or more configs that will be\nexposed to the service.\n",
"items": {
"type": "object",
"properties": {
"File": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name represents the final filename in the filesystem.\n"
},
"UID": {
"type": "string",
"description": "UID represents the file UID."
},
"GID": {
"type": "string",
"description": "GID represents the file GID."
},
"Mode": {
"type": "integer",
"description": "Mode represents the FileMode of the file.",
"format": "uint32"
}
},
"description": "File represents a specific target that is backed by a file.\n\n<p><br /><p>\n\n> **Note**: `Configs.File` and `Configs.Runtime` are mutually exclusive\n"
},
"Runtime": {
"type": "object",
"properties": {},
"description": "Runtime represents a target that is not mounted into the\ncontainer but is used by the task\n\n<p><br /><p>\n\n> **Note**: `Configs.File` and `Configs.Runtime` are mutually\n> exclusive\n"
},
"ConfigID": {
"type": "string",
"description": "ConfigID represents the ID of the specific config that we're\nreferencing.\n"
},
"ConfigName": {
"type": "string",
"description": "ConfigName is the name of the config that this references,\nbut this is just provided for lookup/display purposes. The\nconfig in the reference will be identified by its ID.\n"
}
}
}
},
"Isolation": {
"type": "string",
"description": "Isolation technology of the containers running the service.\n(Windows only)\n",
"enum": [
"default",
"process",
"hyperv"
]
},
"Init": {
"type": "boolean",
"description": "Run an init inside the container that forwards signals and reaps\nprocesses. This field is omitted if empty, and the default (as\nconfigured on the daemon) is used.\n",
"nullable": true
},
"Sysctls": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Set kernel namedspaced parameters (sysctls) in the container.\nThe Sysctls option on services accepts the same sysctls as the\nare supported on containers. Note that while the same sysctls are\nsupported, no guarantees or checks are made about their\nsuitability for a clustered environment, and it's up to the user\nto determine whether a given sysctl will work properly in a\nService.\n"
},
"CapabilityAdd": {
"type": "array",
"description": "A list of kernel capabilities to add to the default set\nfor the container.\n",
"example": [
"CAP_NET_RAW",
"CAP_SYS_ADMIN",
"CAP_SYS_CHROOT",
"CAP_SYSLOG"
],
"items": {
"type": "string"
}
},
"CapabilityDrop": {
"type": "array",
"description": "A list of kernel capabilities to drop from the default set\nfor the container.\n",
"example": [
"CAP_NET_RAW"
],
"items": {
"type": "string"
}
},
"Ulimits": {
"type": "array",
"description": "A list of resource limits to set in the container. For example: `{\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}`\"\n",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of ulimit"
},
"Soft": {
"type": "integer",
"description": "Soft limit"
},
"Hard": {
"type": "integer",
"description": "Hard limit"
}
}
}
}
},
"description": "Container spec for the service.\n\n<p><br /></p>\n\n> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are\n> mutually exclusive. PluginSpec is only used when the Runtime field\n> is set to `plugin`. NetworkAttachmentSpec is used when the Runtime\n> field is set to `attachment`.\n"
},
"NetworkAttachmentSpec": {
"type": "object",
"properties": {
"ContainerID": {
"type": "string",
"description": "ID of the container represented by this task"
}
},
"description": "Read-only spec type for non-swarm containers attached to swarm overlay\nnetworks.\n\n<p><br /></p>\n\n> **Note**: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are\n> mutually exclusive. PluginSpec is only used when the Runtime field\n> is set to `plugin`. NetworkAttachmentSpec is used when the Runtime\n> field is set to `attachment`.\n"
},
"Resources": {
"type": "object",
"properties": {
"Limits": {
"$ref": "#/components/schemas/Limit"
},
"Reservations": {
"$ref": "#/components/schemas/ResourceObject"
}
},
"description": "Resource requirements which apply to each individual container created\nas part of the service.\n"
},
"RestartPolicy": {
"type": "object",
"properties": {
"Condition": {
"type": "string",
"description": "Condition for restart.",
"enum": [
"none",
"on-failure",
"any"
]
},
"Delay": {
"type": "integer",
"description": "Delay between restart attempts.",
"format": "int64"
},
"MaxAttempts": {
"type": "integer",
"description": "Maximum attempts to restart a given container before giving up\n(default value is 0, which is ignored).\n",
"format": "int64",
"default": 0
},
"Window": {
"type": "integer",
"description": "Windows is the time window used to evaluate the restart policy\n(default value is 0, which is unbounded).\n",
"format": "int64",
"default": 0
}
},
"description": "Specification for the restart policy which applies to containers\ncreated as part of this service.\n"
},
"Placement": {
"type": "object",
"properties": {
"Constraints": {
"type": "array",
"description": "An array of constraint expressions to limit the set of nodes where\na task can be scheduled. Constraint expressions can either use a\n_match_ (`==`) or _exclude_ (`!=`) rule. Multiple constraints find\nnodes that satisfy every expression (AND match). Constraints can\nmatch node or Docker Engine labels as follows:\n\nnode attribute | matches | example\n---------------------|--------------------------------|-----------------------------------------------\n`node.id` | Node ID | `node.id==2ivku8v2gvtg4`\n`node.hostname` | Node hostname | `node.hostname!=node-2`\n`node.role` | Node role (`manager`/`worker`) | `node.role==manager`\n`node.platform.os` | Node operating system | `node.platform.os==windows`\n`node.platform.arch` | Node architecture | `node.platform.arch==x86_64`\n`node.labels` | User-defined node labels | `node.labels.security==high`\n`engine.labels` | Docker Engine's labels | `engine.labels.operatingsystem==ubuntu-14.04`\n\n`engine.labels` apply to Docker Engine labels like operating system,\ndrivers, etc. Swarm administrators add `node.labels` for operational\npurposes by using the [`node update endpoint`](#operation/NodeUpdate).\n",
"example": [
"node.hostname!=node3.corp.example.com",
"node.role!=manager",
"node.labels.type==production",
"node.platform.os==linux",
"node.platform.arch==x86_64"
],
"items": {
"type": "string"
}
},
"Preferences": {
"type": "array",
"description": "Preferences provide a way to make the scheduler aware of factors\nsuch as topology. They are provided in order from highest to\nlowest precedence.\n",
"example": [
{
"Spread": {
"SpreadDescriptor": "node.labels.datacenter"
}
},
{
"Spread": {
"SpreadDescriptor": "node.labels.rack"
}
}
],
"items": {
"type": "object",
"properties": {
"Spread": {
"type": "object",
"properties": {
"SpreadDescriptor": {
"type": "string",
"description": "label descriptor, such as `engine.labels.az`.\n"
}
}
}
}
}
},
"MaxReplicas": {
"type": "integer",
"description": "Maximum number of replicas for per node (default value is 0, which\nis unlimited)\n",
"format": "int64",
"default": 0
},
"Platforms": {
"type": "array",
"description": "Platforms stores all the platforms that the service's image can\nrun on. This field is used in the platform filter for scheduling.\nIf empty, then the platform filter is off, meaning there are no\nscheduling restrictions.\n",
"items": {
"$ref": "#/components/schemas/Platform"
}
}
}
},
"ForceUpdate": {
"type": "integer",
"description": "A counter that triggers an update even if no relevant parameters have\nbeen changed.\n"
},
"Runtime": {
"type": "string",
"description": "Runtime is the type of runtime specified for the task executor.\n"
},
"Networks": {
"type": "array",
"description": "Specifies which networks the service should attach to.",
"items": {
"$ref": "#/components/schemas/NetworkAttachmentConfig"
}
},
"LogDriver": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"description": "Specifies the log driver to use for tasks created from this spec. If\nnot present, the default one for the swarm will be used, finally\nfalling back to the engine default if not specified.\n"
}
},
"description": "User modifiable task configuration."
},
"TaskState": {
"type": "string",
"enum": [
"new",
"allocated",
"pending",
"assigned",
"accepted",
"preparing",
"ready",
"starting",
"running",
"complete",
"shutdown",
"failed",
"rejected",
"remove",
"orphaned"
]
},
"Task": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "The ID of the task."
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"format": "dateTime"
},
"UpdatedAt": {
"type": "string",
"format": "dateTime"
},
"Name": {
"type": "string",
"description": "Name of the task."
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"Spec": {
"$ref": "#/components/schemas/TaskSpec"
},
"ServiceID": {
"type": "string",
"description": "The ID of the service this task is part of."
},
"Slot": {
"type": "integer"
},
"NodeID": {
"type": "string",
"description": "The ID of the node that this task is on."
},
"AssignedGenericResources": {
"$ref": "#/components/schemas/GenericResources"
},
"Status": {
"type": "object",
"properties": {
"Timestamp": {
"type": "string",
"format": "dateTime"
},
"State": {
"$ref": "#/components/schemas/TaskState"
},
"Message": {
"type": "string"
},
"Err": {
"type": "string"
},
"ContainerStatus": {
"type": "object",
"properties": {
"ContainerID": {
"type": "string"
},
"PID": {
"type": "integer"
},
"ExitCode": {
"type": "integer"
}
}
}
}
},
"DesiredState": {
"$ref": "#/components/schemas/TaskState"
},
"JobIteration": {
"$ref": "#/components/schemas/ObjectVersion"
}
},
"example": {
"ID": "0kzzo1i0y4jz6027t0k7aezc7",
"Version": {
"Index": 71
},
"CreatedAt": "2016-06-07T21:07:31.171892745Z",
"UpdatedAt": "2016-06-07T21:07:31.376370513Z",
"Spec": {
"ContainerSpec": {
"Image": "redis"
},
"Resources": {
"Limits": {},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "any",
"MaxAttempts": 0
},
"Placement": {}
},
"ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
"Slot": 1,
"NodeID": "60gvrl6tm78dmak4yl7srz94v",
"Status": {
"Timestamp": "2016-06-07T21:07:31.290032978Z",
"State": "running",
"Message": "started",
"ContainerStatus": {
"ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035",
"PID": 677
}
},
"DesiredState": "running",
"NetworksAttachments": [
{
"Network": {
"ID": "4qvuz4ko70xaltuqbt8956gd1",
"Version": {
"Index": 18
},
"CreatedAt": "2016-06-07T20:31:11.912919752Z",
"UpdatedAt": "2016-06-07T21:07:29.955277358Z",
"Spec": {
"Name": "ingress",
"Labels": {
"com.docker.swarm.internal": "true"
},
"DriverConfiguration": {},
"IPAMOptions": {
"Driver": {},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"DriverState": {
"Name": "overlay",
"Options": {
"com.docker.network.driver.overlay.vxlanid_list": "256"
}
},
"IPAMOptions": {
"Driver": {
"Name": "default"
},
"Configs": [
{
"Subnet": "10.255.0.0/16",
"Gateway": "10.255.0.1"
}
]
}
},
"Addresses": [
"10.255.0.10/16"
]
}
],
"AssignedGenericResources": [
{
"DiscreteResourceSpec": {
"Kind": "SSD",
"Value": 3
}
},
{
"NamedResourceSpec": {
"Kind": "GPU",
"Value": "UUID1"
}
},
{
"NamedResourceSpec": {
"Kind": "GPU",
"Value": "UUID2"
}
}
]
}
},
"ServiceSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the service."
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"TaskTemplate": {
"$ref": "#/components/schemas/TaskSpec"
},
"Mode": {
"type": "object",
"properties": {
"Replicated": {
"type": "object",
"properties": {
"Replicas": {
"type": "integer",
"format": "int64"
}
}
},
"Global": {
"type": "object",
"properties": {}
},
"ReplicatedJob": {
"type": "object",
"properties": {
"MaxConcurrent": {
"type": "integer",
"description": "The maximum number of replicas to run simultaneously.\n",
"format": "int64",
"default": 1
},
"TotalCompletions": {
"type": "integer",
"description": "The total number of replicas desired to reach the Completed\nstate. If unset, will default to the value of `MaxConcurrent`\n",
"format": "int64"
}
},
"description": "The mode used for services with a finite number of tasks that run\nto a completed state.\n"
},
"GlobalJob": {
"type": "object",
"properties": {},
"description": "The mode used for services which run a task to the completed state\non each valid node.\n"
}
},
"description": "Scheduling mode for the service."
},
"UpdateConfig": {
"type": "object",
"properties": {
"Parallelism": {
"type": "integer",
"description": "Maximum number of tasks to be updated in one iteration (0 means\nunlimited parallelism).\n",
"format": "int64"
},
"Delay": {
"type": "integer",
"description": "Amount of time between updates, in nanoseconds.",
"format": "int64"
},
"FailureAction": {
"type": "string",
"description": "Action to take if an updated task fails to run, or stops running\nduring the update.\n",
"enum": [
"continue",
"pause",
"rollback"
]
},
"Monitor": {
"type": "integer",
"description": "Amount of time to monitor each updated task for failures, in\nnanoseconds.\n",
"format": "int64"
},
"MaxFailureRatio": {
"type": "number",
"description": "The fraction of tasks that may fail during an update before the\nfailure action is invoked, specified as a floating point number\nbetween 0 and 1.\n"
},
"Order": {
"type": "string",
"description": "The order of operations when rolling out an updated task. Either\nthe old task is shut down before the new task is started, or the\nnew task is started before the old task is shut down.\n",
"enum": [
"stop-first",
"start-first"
]
}
},
"description": "Specification for the update strategy of the service."
},
"RollbackConfig": {
"type": "object",
"properties": {
"Parallelism": {
"type": "integer",
"description": "Maximum number of tasks to be rolled back in one iteration (0 means\nunlimited parallelism).\n",
"format": "int64"
},
"Delay": {
"type": "integer",
"description": "Amount of time between rollback iterations, in nanoseconds.\n",
"format": "int64"
},
"FailureAction": {
"type": "string",
"description": "Action to take if an rolled back task fails to run, or stops\nrunning during the rollback.\n",
"enum": [
"continue",
"pause"
]
},
"Monitor": {
"type": "integer",
"description": "Amount of time to monitor each rolled back task for failures, in\nnanoseconds.\n",
"format": "int64"
},
"MaxFailureRatio": {
"type": "number",
"description": "The fraction of tasks that may fail during a rollback before the\nfailure action is invoked, specified as a floating point number\nbetween 0 and 1.\n"
},
"Order": {
"type": "string",
"description": "The order of operations when rolling back a task. Either the old\ntask is shut down before the new task is started, or the new task\nis started before the old task is shut down.\n",
"enum": [
"stop-first",
"start-first"
]
}
},
"description": "Specification for the rollback strategy of the service."
},
"Networks": {
"type": "array",
"description": "Specifies which networks the service should attach to.",
"items": {
"$ref": "#/components/schemas/NetworkAttachmentConfig"
}
},
"EndpointSpec": {
"$ref": "#/components/schemas/EndpointSpec"
}
},
"description": "User modifiable configuration for a service."
},
"EndpointPortConfig": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Protocol": {
"type": "string",
"enum": [
"tcp",
"udp",
"sctp"
]
},
"TargetPort": {
"type": "integer",
"description": "The port inside the container."
},
"PublishedPort": {
"type": "integer",
"description": "The port on the swarm hosts."
},
"PublishMode": {
"type": "string",
"description": "The mode in which port is published.\n\n<p><br /></p>\n\n- \"ingress\" makes the target port accessible on every node,\n regardless of whether there is a task for the service running on\n that node or not.\n- \"host\" bypasses the routing mesh and publish the port directly on\n the swarm node where that service is running.\n",
"example": "ingress",
"default": "ingress",
"enum": [
"ingress",
"host"
]
}
}
},
"EndpointSpec": {
"type": "object",
"properties": {
"Mode": {
"type": "string",
"description": "The mode of resolution to use for internal load balancing between tasks.\n",
"default": "vip",
"enum": [
"vip",
"dnsrr"
]
},
"Ports": {
"type": "array",
"description": "List of exposed ports that this service is accessible on from the\noutside. Ports can only be provided if `vip` resolution mode is used.\n",
"items": {
"$ref": "#/components/schemas/EndpointPortConfig"
}
}
},
"description": "Properties that can be configured to access and load balance a service."
},
"Service": {
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"format": "dateTime"
},
"UpdatedAt": {
"type": "string",
"format": "dateTime"
},
"Spec": {
"$ref": "#/components/schemas/ServiceSpec"
},
"Endpoint": {
"type": "object",
"properties": {
"Spec": {
"$ref": "#/components/schemas/EndpointSpec"
},
"Ports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndpointPortConfig"
}
},
"VirtualIPs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"NetworkID": {
"type": "string"
},
"Addr": {
"type": "string"
}
}
}
}
}
},
"UpdateStatus": {
"type": "object",
"properties": {
"State": {
"type": "string",
"enum": [
"updating",
"paused",
"completed"
]
},
"StartedAt": {
"type": "string",
"format": "dateTime"
},
"CompletedAt": {
"type": "string",
"format": "dateTime"
},
"Message": {
"type": "string"
}
},
"description": "The status of a service update."
},
"ServiceStatus": {
"type": "object",
"properties": {
"RunningTasks": {
"type": "integer",
"description": "The number of tasks for the service currently in the Running state.\n",
"format": "uint64",
"example": 7
},
"DesiredTasks": {
"type": "integer",
"description": "The number of tasks for the service desired to be running.\nFor replicated services, this is the replica count from the\nservice spec. For global services, this is computed by taking\ncount of all tasks for the service with a Desired State other\nthan Shutdown.\n",
"format": "uint64",
"example": 10
},
"CompletedTasks": {
"type": "integer",
"description": "The number of tasks for a job that are in the Completed state.\nThis field must be cross-referenced with the service type, as the\nvalue of 0 may mean the service is not in a job mode, or it may\nmean the job-mode service has no tasks yet Completed.\n",
"format": "uint64"
}
},
"description": "The status of the service's tasks. Provided only when requested as\npart of a ServiceList operation.\n"
},
"JobStatus": {
"type": "object",
"properties": {
"JobIteration": {
"$ref": "#/components/schemas/ObjectVersion"
},
"LastExecution": {
"type": "string",
"description": "The last time, as observed by the server, that this job was\nstarted.\n",
"format": "dateTime"
}
},
"description": "The status of the service when it is in one of ReplicatedJob or\nGlobalJob modes. Absent on Replicated and Global mode services. The\nJobIteration is an ObjectVersion, but unlike the Service's version,\ndoes not need to be sent with an update request.\n"
}
},
"example": {
"ID": "9mnpnzenvg8p8tdbtq4wvbkcz",
"Version": {
"Index": 19
},
"CreatedAt": "2016-06-07T21:05:51.880065305Z",
"UpdatedAt": "2016-06-07T21:07:29.962229872Z",
"Spec": {
"Name": "hopeful_cori",
"TaskTemplate": {
"ContainerSpec": {
"Image": "redis"
},
"Resources": {
"Limits": {},
"Reservations": {}
},
"RestartPolicy": {
"Condition": "any",
"MaxAttempts": 0
},
"Placement": {},
"ForceUpdate": 0
},
"Mode": {
"Replicated": {
"Replicas": 1
}
},
"UpdateConfig": {
"Parallelism": 1,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"RollbackConfig": {
"Parallelism": 1,
"Delay": 1000000000,
"FailureAction": "pause",
"Monitor": 15000000000,
"MaxFailureRatio": 0.15
},
"EndpointSpec": {
"Mode": "vip",
"Ports": [
{
"Protocol": "tcp",
"TargetPort": 6379,
"PublishedPort": 30001
}
]
}
},
"Endpoint": {
"Spec": {
"Mode": "vip",
"Ports": [
{
"Protocol": "tcp",
"TargetPort": 6379,
"PublishedPort": 30001
}
]
},
"Ports": [
{
"Protocol": "tcp",
"TargetPort": 6379,
"PublishedPort": 30001
}
],
"VirtualIPs": [
{
"NetworkID": "4qvuz4ko70xaltuqbt8956gd1",
"Addr": "10.255.0.2/16"
},
{
"NetworkID": "4qvuz4ko70xaltuqbt8956gd1",
"Addr": "10.255.0.3/16"
}
]
}
}
},
"ImageDeleteResponseItem": {
"type": "object",
"properties": {
"Untagged": {
"type": "string",
"description": "The image ID of an image that was untagged"
},
"Deleted": {
"type": "string",
"description": "The image ID of an image that was deleted"
}
}
},
"ServiceUpdateResponse": {
"type": "object",
"properties": {
"Warnings": {
"type": "array",
"description": "Optional warning messages",
"items": {
"type": "string"
}
}
},
"example": {
"Warning": "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
}
},
"ContainerSummary": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of this container",
"x-go-name": "ID"
},
"Names": {
"type": "array",
"description": "The names that this container has been given",
"items": {
"type": "string"
}
},
"Image": {
"type": "string",
"description": "The name of the image used when creating this container"
},
"ImageID": {
"type": "string",
"description": "The ID of the image that this container was created from"
},
"Command": {
"type": "string",
"description": "Command to run when starting the container"
},
"Created": {
"type": "integer",
"description": "When the container was created",
"format": "int64"
},
"Ports": {
"type": "array",
"description": "The ports exposed by this container",
"items": {
"$ref": "#/components/schemas/Port"
}
},
"SizeRw": {
"type": "integer",
"description": "The size of files that have been created or changed by this container",
"format": "int64"
},
"SizeRootFs": {
"type": "integer",
"description": "The total size of all the files in this container",
"format": "int64"
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"State": {
"type": "string",
"description": "The state of this container (e.g. `Exited`)"
},
"Status": {
"type": "string",
"description": "Additional human-readable status of this container (e.g. `Exit 0`)"
},
"HostConfig": {
"type": "object",
"properties": {
"NetworkMode": {
"type": "string"
}
}
},
"NetworkSettings": {
"type": "object",
"properties": {
"Networks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EndpointSettings"
}
}
},
"description": "A summary of the container's network settings"
},
"Mounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MountPoint"
}
}
}
},
"Driver": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the driver.",
"nullable": false,
"example": "some-driver"
},
"Options": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Key/value map of driver-specific options.",
"nullable": false,
"example": {
"OptionA": "value for driver-specific option A",
"OptionB": "value for driver-specific option B"
}
}
},
"description": "Driver represents a driver (network, logging, secrets)."
},
"SecretSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "User-defined name of the secret."
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata.",
"example": {
"com.example.some-label": "some-value",
"com.example.some-other-label": "some-other-value"
}
},
"Data": {
"type": "string",
"description": "Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5))\ndata to store as secret.\n\nThis field is only used to _create_ a secret, and is not returned by\nother endpoints.\n",
"example": ""
},
"Driver": {
"$ref": "#/components/schemas/Driver"
},
"Templating": {
"$ref": "#/components/schemas/Driver"
}
}
},
"Secret": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"example": "blt1owaxmitz71s9v5zh81zun"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"format": "dateTime",
"example": "2017-07-20T13:55:28.678958722Z"
},
"UpdatedAt": {
"type": "string",
"format": "dateTime",
"example": "2017-07-20T13:55:28.678958722Z"
},
"Spec": {
"$ref": "#/components/schemas/SecretSpec"
}
}
},
"ConfigSpec": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "User-defined name of the config."
},
"Labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "User-defined key/value metadata."
},
"Data": {
"type": "string",
"description": "Base64-url-safe-encoded ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-5))\nconfig data.\n"
},
"Templating": {
"$ref": "#/components/schemas/Driver"
}
}
},
"Config": {
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"format": "dateTime"
},
"UpdatedAt": {
"type": "string",
"format": "dateTime"
},
"Spec": {
"$ref": "#/components/schemas/ConfigSpec"
}
}
},
"ContainerState": {
"type": "object",
"properties": {
"Status": {
"type": "string",
"description": "String representation of the container state. Can be one of \"created\",\n\"running\", \"paused\", \"restarting\", \"removing\", \"exited\", or \"dead\".\n",
"example": "running",
"enum": [
"created",
"running",
"paused",
"restarting",
"removing",
"exited",
"dead"
]
},
"Running": {
"type": "boolean",
"description": "Whether this container is running.\n\nNote that a running container can be _paused_. The `Running` and `Paused`\nbooleans are not mutually exclusive:\n\nWhen pausing a container (on Linux), the freezer cgroup is used to suspend\nall processes in the container. Freezing the process requires the process to\nbe running. As a result, paused containers are both `Running` _and_ `Paused`.\n\nUse the `Status` field instead to determine if a container's state is \"running\".\n",
"example": true
},
"Paused": {
"type": "boolean",
"description": "Whether this container is paused.",
"example": false
},
"Restarting": {
"type": "boolean",
"description": "Whether this container is restarting.",
"example": false
},
"OOMKilled": {
"type": "boolean",
"description": "Whether a process within this container has been killed because it ran\nout of memory since the container was last started.\n",
"example": false
},
"Dead": {
"type": "boolean",
"example": false
},
"Pid": {
"type": "integer",
"description": "The process ID of this container",
"example": 1234
},
"ExitCode": {
"type": "integer",
"description": "The last exit code of this container",
"example": 0
},
"Error": {
"type": "string"
},
"StartedAt": {
"type": "string",
"description": "The time when this container was last started.",
"example": "2020-01-06T09:06:59.461876391Z"
},
"FinishedAt": {
"type": "string",
"description": "The time when this container last exited.",
"example": "2020-01-06T09:07:59.461876391Z"
},
"Health": {
"$ref": "#/components/schemas/Health"
}
},
"description": "ContainerState stores container's running state. It's part of ContainerJSONBase\nand will be returned by the \"inspect\" command.\n",
"nullable": true,
"x-nullable": true
},
"ContainerCreateResponse": {
"title": "ContainerCreateResponse",
"required": [
"Id",
"Warnings"
],
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The ID of the created container",
"nullable": false,
"example": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
},
"Warnings": {
"type": "array",
"description": "Warnings encountered when creating the container",
"nullable": false,
"example": [],
"items": {
"type": "string"
}
}
},
"description": "OK response to ContainerCreate operation",
"x-go-name": "CreateResponse"
},
"ContainerWaitResponse": {
"title": "ContainerWaitResponse",
"required": [
"StatusCode"
],
"type": "object",
"properties": {
"StatusCode": {
"type": "integer",
"description": "Exit code of the container",
"format": "int64",
"nullable": false
},
"Error": {
"$ref": "#/components/schemas/ContainerWaitExitError"
}
},
"description": "OK response to ContainerWait operation",
"x-go-name": "WaitResponse"
},
"ContainerWaitExitError": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"description": "Details of an error"
}
},
"description": "container waiting error, if any",
"x-go-name": "WaitExitError"
},
"SystemVersion": {
"type": "object",
"properties": {
"Platform": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"type": "string"
}
}
},
"Components": {
"type": "array",
"description": "Information about system components\n",
"items": {
"required": [
"Name",
"Version"
],
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the component\n",
"example": "Engine"
},
"Version": {
"type": "string",
"description": "Version of the component\n",
"nullable": false,
"example": "19.03.12"
},
"Details": {
"type": "object",
"properties": {},
"description": "Key/value pairs of strings with additional information about the\ncomponent. These values are intended for informational purposes\nonly, and their content is not defined, and not part of the API\nspecification.\n\nThese messages can be printed by the client as information to the user.\n",
"nullable": true
}
},
"x-go-name": "ComponentVersion"
}
},
"Version": {
"type": "string",
"description": "The version of the daemon",
"example": "19.03.12"
},
"ApiVersion": {
"type": "string",
"description": "The default (and highest) API version that is supported by the daemon\n",
"example": "1.40"
},
"MinAPIVersion": {
"type": "string",
"description": "The minimum API version that is supported by the daemon\n",
"example": "1.12"
},
"GitCommit": {
"type": "string",
"description": "The Git commit of the source code that was used to build the daemon\n",
"example": "48a66213fe"
},
"GoVersion": {
"type": "string",
"description": "The version Go used to compile the daemon, and the version of the Go\nruntime in use.\n",
"example": "go1.13.14"
},
"Os": {
"type": "string",
"description": "The operating system that the daemon is running on (\"linux\" or \"windows\")\n",
"example": "linux"
},
"Arch": {
"type": "string",
"description": "The architecture that the daemon is running on\n",
"example": "amd64"
},
"KernelVersion": {
"type": "string",
"description": "The kernel version (`uname -r`) that the daemon is running on.\n\nThis field is omitted when empty.\n",
"example": "4.19.76-linuxkit"
},
"Experimental": {
"type": "boolean",
"description": "Indicates if the daemon is started with experimental features enabled.\n\nThis field is omitted when empty / false.\n",
"example": true
},
"BuildTime": {
"type": "string",
"description": "The date and time that the daemon was compiled.\n",
"example": "2020-06-22T15:49:27.000000000+00:00"
}
},
"description": "Response of Engine API: GET \"/version\"\n"
},
"SystemInfo": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "Unique identifier of the daemon.\n\n<p><br /></p>\n\n> **Note**: The format of the ID itself is not part of the API, and\n> should not be considered stable.\n",
"example": "7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS"
},
"Containers": {
"type": "integer",
"description": "Total number of containers on the host.",
"example": 14
},
"ContainersRunning": {
"type": "integer",
"description": "Number of containers with status `\"running\"`.\n",
"example": 3
},
"ContainersPaused": {
"type": "integer",
"description": "Number of containers with status `\"paused\"`.\n",
"example": 1
},
"ContainersStopped": {
"type": "integer",
"description": "Number of containers with status `\"stopped\"`.\n",
"example": 10
},
"Images": {
"type": "integer",
"description": "Total number of images on the host.\n\nBoth _tagged_ and _untagged_ (dangling) images are counted.\n",
"example": 508
},
"Driver": {
"type": "string",
"description": "Name of the storage driver in use.",
"example": "overlay2"
},
"DriverStatus": {
"type": "array",
"description": "Information specific to the storage driver, provided as\n\"label\" / \"value\" pairs.\n\nThis information is provided by the storage driver, and formatted\nin a way consistent with the output of `docker info` on the command\nline.\n\n<p><br /></p>\n\n> **Note**: The information returned in this field, including the\n> formatting of values and labels, should not be considered stable,\n> and may change without notice.\n",
"example": [
[
"Backing Filesystem",
"extfs"
],
[
"Supports d_type",
"true"
],
[
"Native Overlay Diff",
"true"
]
],
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"DockerRootDir": {
"type": "string",
"description": "Root directory of persistent Docker state.\n\nDefaults to `/var/lib/docker` on Linux, and `C:\\ProgramData\\docker`\non Windows.\n",
"example": "/var/lib/docker"
},
"Plugins": {
"$ref": "#/components/schemas/PluginsInfo"
},
"MemoryLimit": {
"type": "boolean",
"description": "Indicates if the host has memory limit support enabled.",
"example": true
},
"SwapLimit": {
"type": "boolean",
"description": "Indicates if the host has memory swap limit support enabled.",
"example": true
},
"KernelMemoryTCP": {
"type": "boolean",
"description": "Indicates if the host has kernel memory TCP limit support enabled. This\nfield is omitted if not supported.\n\nKernel memory TCP limits are not supported when using cgroups v2, which\ndoes not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.\n",
"example": true
},
"CpuCfsPeriod": {
"type": "boolean",
"description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by\nthe host.\n",
"example": true
},
"CpuCfsQuota": {
"type": "boolean",
"description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by\nthe host.\n",
"example": true
},
"CPUShares": {
"type": "boolean",
"description": "Indicates if CPU Shares limiting is supported by the host.\n",
"example": true
},
"CPUSet": {
"type": "boolean",
"description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host.\n\nSee [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)\n",
"example": true
},
"PidsLimit": {
"type": "boolean",
"description": "Indicates if the host kernel has PID limit support enabled.",
"example": true
},
"OomKillDisable": {
"type": "boolean",
"description": "Indicates if OOM killer disable is supported on the host."
},
"IPv4Forwarding": {
"type": "boolean",
"description": "Indicates IPv4 forwarding is enabled.",
"example": true
},
"BridgeNfIptables": {
"type": "boolean",
"description": "Indicates if `bridge-nf-call-iptables` is available on the host.",
"example": true
},
"BridgeNfIp6tables": {
"type": "boolean",
"description": "Indicates if `bridge-nf-call-ip6tables` is available on the host.",
"example": true
},
"Debug": {
"type": "boolean",
"description": "Indicates if the daemon is running in debug-mode / with debug-level\nlogging enabled.\n",
"example": true
},
"NFd": {
"type": "integer",
"description": "The total number of file Descriptors in use by the daemon process.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 64
},
"NGoroutines": {
"type": "integer",
"description": "The number of goroutines that currently exist.\n\nThis information is only returned if debug-mode is enabled.\n",
"example": 174
},
"SystemTime": {
"type": "string",
"description": "Current system-time in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat with nano-seconds.\n",
"example": "2017-08-08T20:28:29.06202363Z"
},
"LoggingDriver": {
"type": "string",
"description": "The logging driver to use as a default for new containers.\n"
},
"CgroupDriver": {
"type": "string",
"description": "The driver to use for managing cgroups.\n",
"example": "cgroupfs",
"default": "cgroupfs",
"enum": [
"cgroupfs",
"systemd",
"none"
]
},
"CgroupVersion": {
"type": "string",
"description": "The version of the cgroup.\n",
"example": "1",
"default": "1",
"enum": [
"1",
"2"
]
},
"NEventsListener": {
"type": "integer",
"description": "Number of event listeners subscribed.",
"example": 30
},
"KernelVersion": {
"type": "string",
"description": "Kernel version of the host.\n\nOn Linux, this information obtained from `uname`. On Windows this\ninformation is queried from the <kbd>HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Windows NT\\\\CurrentVersion\\\\</kbd>\nregistry value, for example _\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\"_.\n",
"example": "4.9.38-moby"
},
"OperatingSystem": {
"type": "string",
"description": "Name of the host's operating system, for example: \"Ubuntu 16.04.2 LTS\"\nor \"Windows Server 2016 Datacenter\"\n",
"example": "Alpine Linux v3.5"
},
"OSVersion": {
"type": "string",
"description": "Version of the host's operating system\n\n<p><br /></p>\n\n> **Note**: The information returned in this field, including its\n> very existence, and the formatting of values, should not be considered\n> stable, and may change without notice.\n",
"example": "16.04"
},
"OSType": {
"type": "string",
"description": "Generic type of the operating system of the host, as returned by the\nGo runtime (`GOOS`).\n\nCurrently returned values are \"linux\" and \"windows\". A full list of\npossible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).\n",
"example": "linux"
},
"Architecture": {
"type": "string",
"description": "Hardware architecture of the host, as returned by the Go runtime\n(`GOARCH`).\n\nA full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).\n",
"example": "x86_64"
},
"NCPU": {
"type": "integer",
"description": "The number of logical CPUs usable by the daemon.\n\nThe number of available CPUs is checked by querying the operating\nsystem when the daemon starts. Changes to operating system CPU\nallocation after the daemon is started are not reflected.\n",
"example": 4
},
"MemTotal": {
"type": "integer",
"description": "Total amount of physical memory available on the host, in bytes.\n",
"format": "int64",
"example": 2095882240
},
"IndexServerAddress": {
"type": "string",
"description": "Address / URL of the index server that is used for image search,\nand as a default for user authentication for Docker Hub and Docker Cloud.\n",
"example": "https://index.docker.io/v1/",
"default": "https://index.docker.io/v1/"
},
"RegistryConfig": {
"$ref": "#/components/schemas/RegistryServiceConfig"
},
"GenericResources": {
"$ref": "#/components/schemas/GenericResources"
},
"HttpProxy": {
"type": "string",
"description": "HTTP-proxy configured for the daemon. This value is obtained from the\n[`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "http://xxxxx:[email protected]:8080"
},
"HttpsProxy": {
"type": "string",
"description": "HTTPS-proxy configured for the daemon. This value is obtained from the\n[`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable.\nCredentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL\nare masked in the API response.\n\nContainers do not automatically inherit this configuration.\n",
"example": "https://xxxxx:[email protected]:4443"
},
"NoProxy": {
"type": "string",
"description": "Comma-separated list of domain extensions for which no proxy should be\nused. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html)\nenvironment variable.\n\nContainers do not automatically inherit this configuration.\n",
"example": "*.local, 169.254/16"
},
"Name": {
"type": "string",
"description": "Hostname of the host.",
"example": "node5.corp.example.com"
},
"Labels": {
"type": "array",
"description": "User-defined labels (key/value metadata) as set on the daemon.\n\n<p><br /></p>\n\n> **Note**: When part of a Swarm, nodes can both have _daemon_ labels,\n> set through the daemon configuration, and _node_ labels, set from a\n> manager node in the Swarm. Node labels are not included in this\n> field. Node labels can be retrieved using the `/nodes/(id)` endpoint\n> on a manager node in the Swarm.\n",
"example": [
"storage=ssd",
"production"
],
"items": {
"type": "string"
}
},
"ExperimentalBuild": {
"type": "boolean",
"description": "Indicates if experimental features are enabled on the daemon.\n",
"example": true
},
"ServerVersion": {
"type": "string",
"description": "Version string of the daemon.\n",
"example": "24.0.2"
},
"Runtimes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Runtime"
},
"description": "List of [OCI compliant](https://github.com/opencontainers/runtime-spec)\nruntimes configured on the daemon. Keys hold the \"name\" used to\nreference the runtime.\n\nThe Docker daemon relies on an OCI compliant runtime (invoked via the\n`containerd` daemon) as its interface to the Linux kernel namespaces,\ncgroups, and SELinux.\n\nThe default runtime is `runc`, and automatically configured. Additional\nruntimes can be configured by the user and will be listed here.\n",
"example": {
"runc": {
"path": "runc"
},
"runc-master": {
"path": "/go/bin/runc"
},
"custom": {
"path": "/usr/local/bin/my-oci-runtime",
"runtimeArgs": [
"--debug",
"--systemd-cgroup=false"
]
}
}
},
"DefaultRuntime": {
"type": "string",
"description": "Name of the default OCI runtime that is used when starting containers.\n\nThe default can be overridden per-container at create time.\n",
"example": "runc",
"default": "runc"
},
"Swarm": {
"$ref": "#/components/schemas/SwarmInfo"
},
"LiveRestoreEnabled": {
"type": "boolean",
"description": "Indicates if live restore is enabled.\n\nIf enabled, containers are kept running when the daemon is shutdown\nor upon daemon start if running containers are detected.\n",
"example": false,
"default": false
},
"Isolation": {
"type": "string",
"description": "Represents the isolation technology to use as a default for containers.\nThe supported values are platform-specific.\n\nIf no isolation value is specified on daemon start, on Windows client,\nthe default is `hyperv`, and on Windows server, the default is `process`.\n\nThis option is currently not used on other platforms.\n",
"default": "default",
"enum": [
"default",
"hyperv",
"process"
]
},
"InitBinary": {
"type": "string",
"description": "Name and, optional, path of the `docker-init` binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
"example": "docker-init"
},
"ContainerdCommit": {
"$ref": "#/components/schemas/Commit"
},
"RuncCommit": {
"$ref": "#/components/schemas/Commit"
},
"InitCommit": {
"$ref": "#/components/schemas/Commit"
},
"SecurityOptions": {
"type": "array",
"description": "List of security features that are enabled on the daemon, such as\napparmor, seccomp, SELinux, user-namespaces (userns), rootless and\nno-new-privileges.\n\nAdditional configuration options for each security feature may\nbe present, and are included as a comma-separated list of key/value\npairs.\n",
"example": [
"name=apparmor",
"name=seccomp,profile=default",
"name=selinux",
"name=userns",
"name=rootless"
],
"items": {
"type": "string"
}
},
"ProductLicense": {
"type": "string",
"description": "Reports a summary of the product license on the daemon.\n\nIf a commercial license has been applied to the daemon, information\nsuch as number of nodes, and expiration are included.\n",
"example": "Community Engine"
},
"DefaultAddressPools": {
"type": "array",
"description": "List of custom default address pools for local networks, which can be\nspecified in the daemon.json file or dockerd option.\n\nExample: a Base \"10.10.0.0/16\" with Size 24 will define the set of 256\n10.10.[0-255].0/24 address pools.\n",
"items": {
"type": "object",
"properties": {
"Base": {
"type": "string",
"description": "The network address in CIDR format",
"example": "10.10.0.0/16"
},
"Size": {
"type": "integer",
"description": "The network pool size",
"example": 24
}
}
}
},
"Warnings": {
"type": "array",
"description": "List of warnings / informational messages about missing features, or\nissues related to the daemon configuration.\n\nThese messages can be printed by the client as information to the user.\n",
"example": [
"WARNING: No memory limit support",
"WARNING: bridge-nf-call-iptables is disabled",
"WARNING: bridge-nf-call-ip6tables is disabled"
],
"items": {
"type": "string"
}
}
}
},
"PluginsInfo": {
"type": "object",
"properties": {
"Volume": {
"type": "array",
"description": "Names of available volume-drivers, and network-driver plugins.",
"example": [
"local"
],
"items": {
"type": "string"
}
},
"Network": {
"type": "array",
"description": "Names of available network-drivers, and network-driver plugins.",
"example": [
"bridge",
"host",
"ipvlan",
"macvlan",
"null",
"overlay"
],
"items": {
"type": "string"
}
},
"Authorization": {
"type": "array",
"description": "Names of available authorization plugins.",
"example": [
"img-authz-plugin",
"hbm"
],
"items": {
"type": "string"
}
},
"Log": {
"type": "array",
"description": "Names of available logging-drivers, and logging-driver plugins.",
"example": [
"awslogs",
"fluentd",
"gcplogs",
"gelf",
"journald",
"json-file",
"logentries",
"splunk",
"syslog"
],
"items": {
"type": "string"
}
}
},
"description": "Available plugins per type.\n\n<p><br /></p>\n\n> **Note**: Only unmanaged (V1) plugins are included in this list.\n> V1 plugins are \"lazily\" loaded, and are not returned in this list\n> if there is no resource using the plugin.\n"
},
"RegistryServiceConfig": {
"type": "object",
"properties": {
"AllowNondistributableArtifactsCIDRs": {
"type": "array",
"description": "List of IP ranges to which nondistributable artifacts can be pushed,\nusing the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632).\n\nSome images (for example, Windows base images) contain artifacts\nwhose distribution is restricted by license. When these images are\npushed to a registry, restricted artifacts are not included.\n\nThis configuration override this behavior, and enables the daemon to\npush nondistributable artifacts to all registries whose resolved IP\naddress is within the subnet described by the CIDR syntax.\n\nThis option is useful when pushing images containing\nnondistributable artifacts to a registry on an air-gapped network so\nhosts on that network can pull the images without connecting to\nanother server.\n\n> **Warning**: Nondistributable artifacts typically have restrictions\n> on how and where they can be distributed and shared. Only use this\n> feature to push artifacts to private registries and ensure that you\n> are in compliance with any terms that cover redistributing\n> nondistributable artifacts.\n",
"example": [
"::1/128",
"127.0.0.0/8"
],
"items": {
"type": "string"
}
},
"AllowNondistributableArtifactsHostnames": {
"type": "array",
"description": "List of registry hostnames to which nondistributable artifacts can be\npushed, using the format `<hostname>[:<port>]` or `<IP address>[:<port>]`.\n\nSome images (for example, Windows base images) contain artifacts\nwhose distribution is restricted by license. When these images are\npushed to a registry, restricted artifacts are not included.\n\nThis configuration override this behavior for the specified\nregistries.\n\nThis option is useful when pushing images containing\nnondistributable artifacts to a registry on an air-gapped network so\nhosts on that network can pull the images without connecting to\nanother server.\n\n> **Warning**: Nondistributable artifacts typically have restrictions\n> on how and where they can be distributed and shared. Only use this\n> feature to push artifacts to private registries and ensure that you\n> are in compliance with any terms that cover redistributing\n> nondistributable artifacts.\n",
"example": [
"registry.internal.corp.example.com:3000",
"[2001:db8:a0b:12f0::1]:443"
],
"items": {
"type": "string"
}
},
"InsecureRegistryCIDRs": {
"type": "array",
"description": "List of IP ranges of insecure registries, using the CIDR syntax\n([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries\naccept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates\nfrom unknown CAs) communication.\n\nBy default, local registries (`127.0.0.0/8`) are configured as\ninsecure. All other registries are secure. Communicating with an\ninsecure registry is not possible if the daemon assumes that registry\nis secure.\n\nThis configuration override this behavior, insecure communication with\nregistries whose resolved IP address is within the subnet described by\nthe CIDR syntax.\n\nRegistries can also be marked insecure by hostname. Those registries\nare listed under `IndexConfigs` and have their `Secure` field set to\n`false`.\n\n> **Warning**: Using this option can be useful when running a local\n> registry, but introduces security vulnerabilities. This option\n> should therefore ONLY be used for testing purposes. For increased\n> security, users should add their CA to their system's list of trusted\n> CAs instead of enabling this option.\n",
"example": [
"::1/128",
"127.0.0.0/8"
],
"items": {
"type": "string"
}
},
"IndexConfigs": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/IndexInfo"
},
"example": {
"127.0.0.1:5000": {
"Name": "127.0.0.1:5000",
"Mirrors": [],
"Secure": false,
"Official": false
},
"[2001:db8:a0b:12f0::1]:80": {
"Name": "[2001:db8:a0b:12f0::1]:80",
"Mirrors": [],
"Secure": false,
"Official": false
},
"docker.io": {
"Name": "docker.io",
"Mirrors": [
"https://hub-mirror.corp.example.com:5000/"
],
"Secure": true,
"Official": true
},
"registry.internal.corp.example.com:3000": {
"Name": "registry.internal.corp.example.com:3000",
"Mirrors": [],
"Secure": false,
"Official": false
}
}
},
"Mirrors": {
"type": "array",
"description": "List of registry URLs that act as a mirror for the official\n(`docker.io`) registry.\n",
"example": [
"https://hub-mirror.corp.example.com:5000/",
"https://[2001:db8:a0b:12f0::1]/"
],
"items": {
"type": "string"
}
}
},
"description": "RegistryServiceConfig stores daemon registry services configuration.\n",
"nullable": true,
"x-nullable": true
},
"IndexInfo": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "Name of the registry, such as \"docker.io\".\n",
"example": "docker.io"
},
"Mirrors": {
"type": "array",
"description": "List of mirrors, expressed as URIs.\n",
"example": [
"https://hub-mirror.corp.example.com:5000/",
"https://registry-2.docker.io/",
"https://registry-3.docker.io/"
],
"items": {
"type": "string"
}
},
"Secure": {
"type": "boolean",
"description": "Indicates if the registry is part of the list of insecure\nregistries.\n\nIf `false`, the registry is insecure. Insecure registries accept\nun-encrypted (HTTP) and/or untrusted (HTTPS with certificates from\nunknown CAs) communication.\n\n> **Warning**: Insecure registries can be useful when running a local\n> registry. However, because its use creates security vulnerabilities\n> it should ONLY be enabled for testing purposes. For increased\n> security, users should add their CA to their system's list of\n> trusted CAs instead of enabling this option.\n",
"example": true
},
"Official": {
"type": "boolean",
"description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)\n",
"example": true
}
},
"description": "IndexInfo contains information about a registry.",
"nullable": true,
"x-nullable": true
},
"Runtime": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Name and, optional, path, of the OCI executable binary.\n\nIf the path is omitted, the daemon searches the host's `$PATH` for the\nbinary and uses the first result.\n",
"example": "/usr/local/bin/my-oci-runtime"
},
"runtimeArgs": {
"type": "array",
"description": "List of command-line arguments to pass to the runtime when invoked.\n",
"nullable": true,
"example": [
"--debug",
"--systemd-cgroup=false"
],
"items": {
"type": "string"
}
}
},
"description": "Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec)\nruntime.\n\nThe runtime is invoked by the daemon via the `containerd` daemon. OCI\nruntimes act as an interface to the Linux kernel namespaces, cgroups,\nand SELinux.\n"
},
"Commit": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "Actual commit ID of external tool.",
"example": "cfb82a876ecc11b5ca0977d1733adbe58599088a"
},
"Expected": {
"type": "string",
"description": "Commit ID of external tool expected by dockerd as set at build time.\n",
"example": "2d41c047c83e09a6d61d464906feb2a2f3c52aa4"
}
},
"description": "Commit holds the Git-commit (SHA1) that a binary was built from, as\nreported in the version-string of external tools, such as `containerd`,\nor `runC`.\n"
},
"SwarmInfo": {
"type": "object",
"properties": {
"NodeID": {
"type": "string",
"description": "Unique identifier of for this node in the swarm.",
"example": "k67qz4598weg5unwwffg6z1m1",
"default": ""
},
"NodeAddr": {
"type": "string",
"description": "IP address at which this node can be reached by other nodes in the\nswarm.\n",
"example": "10.0.0.46",
"default": ""
},
"LocalNodeState": {
"$ref": "#/components/schemas/LocalNodeState"
},
"ControlAvailable": {
"type": "boolean",
"example": true,
"default": false
},
"Error": {
"type": "string",
"default": ""
},
"RemoteManagers": {
"type": "array",
"description": "List of ID's and addresses of other managers in the swarm.\n",
"nullable": true,
"example": [
{
"NodeID": "71izy0goik036k48jg985xnds",
"Addr": "10.0.0.158:2377"
},
{
"NodeID": "79y6h1o4gv8n120drcprv5nmc",
"Addr": "10.0.0.159:2377"
},
{
"NodeID": "k67qz4598weg5unwwffg6z1m1",
"Addr": "10.0.0.46:2377"
}
],
"items": {
"$ref": "#/components/schemas/PeerNode"
}
},
"Nodes": {
"type": "integer",
"description": "Total number of nodes in the swarm.",
"nullable": true,
"example": 4
},
"Managers": {
"type": "integer",
"description": "Total number of managers in the swarm.",
"nullable": true,
"example": 3
},
"Cluster": {
"$ref": "#/components/schemas/ClusterInfo"
}
},
"description": "Represents generic information about swarm.\n"
},
"LocalNodeState": {
"type": "string",
"description": "Current local status of this node.",
"example": "active",
"default": "",
"enum": [
"",
"inactive",
"pending",
"active",
"error",
"locked"
]
},
"PeerNode": {
"type": "object",
"properties": {
"NodeID": {
"type": "string",
"description": "Unique identifier of for this node in the swarm."
},
"Addr": {
"type": "string",
"description": "IP address and ports at which this node can be reached.\n"
}
},
"description": "Represents a peer-node in the swarm"
},
"NetworkAttachmentConfig": {
"type": "object",
"properties": {
"Target": {
"type": "string",
"description": "The target network for attachment. Must be a network name or ID.\n"
},
"Aliases": {
"type": "array",
"description": "Discoverable alternate names for the service on this network.\n",
"items": {
"type": "string"
}
},
"DriverOpts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Driver attachment options for the network target.\n"
}
},
"description": "Specifies how a service should be attached to a particular network.\n"
},
"EventActor": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "The ID of the object emitting the event",
"example": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
},
"Attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Various key/value attributes of the object, depending on its type.\n",
"example": {
"com.example.some-label": "some-label-value",
"image": "alpine:latest",
"name": "my-container"
}
}
},
"description": "Actor describes something that generates events, like a container, network,\nor a volume.\n"
},
"EventMessage": {
"title": "SystemEventsResponse",
"type": "object",
"properties": {
"Type": {
"type": "string",
"description": "The type of object emitting the event",
"example": "container",
"enum": [
"builder",
"config",
"container",
"daemon",
"image",
"network",
"node",
"plugin",
"secret",
"service",
"volume"
]
},
"Action": {
"type": "string",
"description": "The type of event",
"example": "create"
},
"Actor": {
"$ref": "#/components/schemas/EventActor"
},
"scope": {
"type": "string",
"description": "Scope of the event. Engine events are `local` scope. Cluster (Swarm)\nevents are `swarm` scope.\n",
"enum": [
"local",
"swarm"
]
},
"time": {
"type": "integer",
"description": "Timestamp of event",
"format": "int64",
"example": 1629574695
},
"timeNano": {
"type": "integer",
"description": "Timestamp of event, with nanosecond accuracy",
"format": "int64",
"example": 1629574695515050031
}
},
"description": "EventMessage represents the information an event contains.\n"
},
"OCIDescriptor": {
"type": "object",
"properties": {
"mediaType": {
"type": "string",
"description": "The media type of the object this schema refers to.\n",
"example": "application/vnd.docker.distribution.manifest.v2+json"
},
"digest": {
"type": "string",
"description": "The digest of the targeted content.\n",
"example": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96"
},
"size": {
"type": "integer",
"description": "The size in bytes of the blob.\n",
"format": "int64",
"example": 3987495
}
},
"description": "A descriptor struct containing digest, media type, and size, as defined in\nthe [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).\n",
"x-go-name": "Descriptor"
},
"OCIPlatform": {
"type": "object",
"properties": {
"architecture": {
"type": "string",
"description": "The CPU architecture, for example `amd64` or `ppc64`.\n",
"example": "arm"
},
"os": {
"type": "string",
"description": "The operating system, for example `linux` or `windows`.\n",
"example": "windows"
},
"os.version": {
"type": "string",
"description": "Optional field specifying the operating system version, for example on\nWindows `10.0.19041.1165`.\n",
"example": "10.0.19041.1165"
},
"os.features": {
"type": "array",
"description": "Optional field specifying an array of strings, each listing a required\nOS feature (for example on Windows `win32k`).\n",
"example": [
"win32k"
],
"items": {
"type": "string"
}
},
"variant": {
"type": "string",
"description": "Optional field specifying a variant of the CPU, for example `v7` to\nspecify ARMv7 when architecture is `arm`.\n",
"example": "v7"
}
},
"description": "Describes the platform which the image in the manifest runs on, as defined\nin the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).\n",
"x-go-name": "Platform"
},
"DistributionInspect": {
"title": "DistributionInspectResponse",
"required": [
"Descriptor",
"Platforms"
],
"type": "object",
"properties": {
"Descriptor": {
"$ref": "#/components/schemas/OCIDescriptor"
},
"Platforms": {
"type": "array",
"description": "An array containing all platforms supported by the image.\n",
"items": {
"$ref": "#/components/schemas/OCIPlatform"
}
}
},
"description": "Describes the result obtained from contacting the registry to retrieve\nimage metadata.\n",
"x-go-name": "DistributionInspect"
},
"ClusterVolume": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"description": "The Swarm ID of this volume. Because cluster volumes are Swarm\nobjects, they have an ID, unlike non-cluster volumes. This ID can\nbe used to refer to the Volume instead of the name.\n"
},
"Version": {
"$ref": "#/components/schemas/ObjectVersion"
},
"CreatedAt": {
"type": "string",
"format": "dateTime"
},
"UpdatedAt": {
"type": "string",
"format": "dateTime"
},
"Spec": {
"$ref": "#/components/schemas/ClusterVolumeSpec"
},
"Info": {
"type": "object",
"properties": {
"CapacityBytes": {
"type": "integer",
"description": "The capacity of the volume in bytes. A value of 0 indicates that\nthe capacity is unknown.\n",
"format": "int64"
},
"VolumeContext": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of strings to strings returned from the storage plugin when\nthe volume is created.\n"
},
"VolumeID": {
"type": "string",
"description": "The ID of the volume as returned by the CSI storage plugin. This\nis distinct from the volume's ID as provided by Docker. This ID\nis never used by the user when communicating with Docker to refer\nto this volume. If the ID is blank, then the Volume has not been\nsuccessfully created in the plugin yet.\n"
},
"AccessibleTopology": {
"type": "array",
"description": "The topology this volume is actually accessible from.\n",
"items": {
"$ref": "#/components/schemas/Topology"
}
}
},
"description": "Information about the global status of the volume.\n"
},
"PublishStatus": {
"type": "array",
"description": "The status of the volume as it pertains to its publishing and use on\nspecific nodes\n",
"items": {
"type": "object",
"properties": {
"NodeID": {
"type": "string",
"description": "The ID of the Swarm node the volume is published on.\n"
},
"State": {
"type": "string",
"description": "The published state of the volume.\n* `pending-publish` The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.\n* `published` The volume is published successfully to the node.\n* `pending-node-unpublish` The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.\n* `pending-controller-unpublish` The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.\n",
"enum": [
"pending-publish",
"published",
"pending-node-unpublish",
"pending-controller-unpublish"
]
},
"PublishContext": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of strings to strings returned by the CSI controller\nplugin when a volume is published.\n"
}
}
}
}
},
"description": "Options and information specific to, and only present on, Swarm CSI\ncluster volumes.\n"
},
"ClusterVolumeSpec": {
"type": "object",
"properties": {
"Group": {
"type": "string",
"description": "Group defines the volume group of this volume. Volumes belonging to\nthe same group can be referred to by group name when creating\nServices. Referring to a volume by group instructs Swarm to treat\nvolumes in that group interchangeably for the purpose of scheduling.\nVolumes with an empty string for a group technically all belong to\nthe same, emptystring group.\n"
},
"AccessMode": {
"type": "object",
"properties": {
"Scope": {
"type": "string",
"description": "The set of nodes this volume can be used on at one time.\n- `single` The volume may only be scheduled to one node at a time.\n- `multi` the volume may be scheduled to any supported number of nodes at a time.\n",
"nullable": false,
"default": "single",
"enum": [
"single",
"multi"
]
},
"Sharing": {
"type": "string",
"description": "The number and way that different tasks can use this volume\nat one time.\n- `none` The volume may only be used by one task at a time.\n- `readonly` The volume may be used by any number of tasks, but they all must mount the volume as readonly\n- `onewriter` The volume may be used by any number of tasks, but only one may mount it as read/write.\n- `all` The volume may have any number of readers and writers.\n",
"nullable": false,
"default": "none",
"enum": [
"none",
"readonly",
"onewriter",
"all"
]
},
"MountVolume": {
"type": "object",
"properties": {},
"description": "Options for using this volume as a Mount-type volume.\n\n Either MountVolume or BlockVolume, but not both, must be\n present.\n properties:\n FsType:\n type: \"string\"\n description: |\n Specifies the filesystem type for the mount volume.\n Optional.\n MountFlags:\n type: \"array\"\n description: |\n Flags to pass when mounting the volume. Optional.\n items:\n type: \"string\"\nBlockVolume:\n type: \"object\"\n description: |\n Options for using this volume as a Block-type volume.\n Intentionally empty.\n"
},
"Secrets": {
"type": "array",
"description": "Swarm Secrets that are passed to the CSI storage plugin when\noperating on this volume.\n",
"items": {
"type": "object",
"properties": {
"Key": {
"type": "string",
"description": "Key is the name of the key of the key-value pair passed to\nthe plugin.\n"
},
"Secret": {
"type": "string",
"description": "Secret is the swarm Secret object from which to read data.\nThis can be a Secret name or ID. The Secret data is\nretrieved by swarm and used as the value of the key-value\npair passed to the plugin.\n"
}
},
"description": "One cluster volume secret entry. Defines a key-value pair that\nis passed to the plugin.\n"
}
},
"AccessibilityRequirements": {
"type": "object",
"properties": {
"Requisite": {
"type": "array",
"description": "A list of required topologies, at least one of which the\nvolume must be accessible from.\n",
"items": {
"$ref": "#/components/schemas/Topology"
}
},
"Preferred": {
"type": "array",
"description": "A list of topologies that the volume should attempt to be\nprovisioned in.\n",
"items": {
"$ref": "#/components/schemas/Topology"
}
}
},
"description": "Requirements for the accessible topology of the volume. These\nfields are optional. For an in-depth description of what these\nfields mean, see the CSI specification.\n"
},
"CapacityRange": {
"type": "object",
"properties": {
"RequiredBytes": {
"type": "integer",
"description": "The volume must be at least this big. The value of 0\nindicates an unspecified minimum\n",
"format": "int64"
},
"LimitBytes": {
"type": "integer",
"description": "The volume must not be bigger than this. The value of 0\nindicates an unspecified maximum.\n",
"format": "int64"
}
},
"description": "The desired capacity that the volume should be created with. If\nempty, the plugin will decide the capacity.\n"
},
"Availability": {
"type": "string",
"description": "The availability of the volume for use in tasks.\n- `active` The volume is fully available for scheduling on the cluster\n- `pause` No new workloads should use the volume, but existing workloads are not stopped.\n- `drain` All workloads using this volume should be stopped and rescheduled, and no new ones should be started.\n",
"nullable": false,
"default": "active",
"enum": [
"active",
"pause",
"drain"
]
}
},
"description": "Defines how the volume is used by tasks.\n"
}
},
"description": "Cluster-specific options used to create the volume.\n"
},
"Topology": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A map of topological domains to topological segments. For in depth\ndetails, see documentation for the Topology object in the CSI\nspecification.\n"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment