v1

latestSwagger 2.02026-07-17108109409.0 KB

Plugin

List plugins

Returns information about installed plugins.

get/plugins

Query parameters

filtersstring

A JSON encoded value of the filters (a map[string][]string) to process on the plugin list.

Available filters:

capability=<capability name>
enable=<true>|<false>

Response

No error

Idstring

Namestring required

Enabledboolean required

True if the plugin is running. False if the plugin is not running, only installed.

PluginReferencestring

plugin remote reference used to push/pull the plugin

Example response

[
  {
    "Id": "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078",
    "Name": "tiborvass/sample-volume-plugin",
    "Enabled": true,
    "Settings": {
      "Mounts": [
        {
          "Name": "some-mount",
          "Description": "This is a mount that's used by the plugin.",
          "Source": "/var/lib/docker/plugins/",
          "Destination": "/mnt/state",
          "Type": "bind",
          "Options": [
            "rbind",
            "rw"
          ]
        }
      ],
      "Env": [
        "DEBUG=0"
      ],
      "Devices": [
        {
          "Path": "/dev/fuse"
        }
      ]
    },
    "PluginReference": "localhost:5000/tiborvass/sample-volume-plugin:latest",
    "Config": {
      "DockerVersion": "17.06.0-ce",
      "Description": "A sample volume plugin for Docker",
      "Documentation": "https://docs.docker.com/engine/extend/plugins/",
      "Interface": {
        "Types": [
          "docker.volumedriver/1.0"
        ],
        "Socket": "plugins.sock",
        "ProtocolScheme": "some.protocol/v1.0"
      },
      "Entrypoint": [
        "/usr/bin/sample-volume-plugin",
        "/data"
      ],
      "WorkDir": "/bin/",
      "User": {
        "UID": 1000,
        "GID": 1000
      },
      "Network": {
        "Type": "host"
      },
      "Linux": {
        "Capabilities": [
          "CAP_SYS_ADMIN",
          "CAP_SYSLOG"
        ],
        "Devices": [
          {
            "Path": "/dev/fuse"
          }
        ]
      },
      "PropagatedMount": "/mnt/volumes",
      "Mounts": [
        {
          "Name": "some-mount",
          "Description": "This is a mount that's used by the plugin.",
          "Source": "/var/lib/docker/plugins/",
          "Destination": "/mnt/state",
          "Type": "bind",
          "Options": [
            "rbind",
            "rw"
          ]
        }
      ],
      "Env": [
        {
          "Name": "DEBUG",
          "Description": "If set, prints debug messages",
          "Settable": null,
          "Value": "0"
        }
      ],
      "Args": {
        "Name": "args",
        "Description": "command line arguments"
      },
      "rootfs": {
        "type": "layers",
        "diff_ids": [
          "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
          "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
        ]
      }
    }
  }
]