v1

latestOpenAPI 3.0.02026-07-1410578280.2 KB
Plugin

Inspect a plugin

get/plugins/{name}/json

Path parameters

namestring required

The name of the plugin. The :latest tag is optional, and is the default if omitted.

Response

no error

Enabledboolean required

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

Idstring
Namestring required
PluginReferencestring

plugin remote reference used to push/pull the plugin

Example response

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