Plugin

Inspect a plugin

Changed on
get/plugins/{name}/json

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

namestring required

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

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": {
    "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"
      ]
    }
  }
}

Changes

    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag Plugin added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      api tag Plugin removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status