Docker Engine API
  1. Plugin
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
    • Create a config
    • Delete a config
    • Inspect a config
    • Update a Config
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
      GET
    • Create a plugin
      POST
    • Get plugin privileges
      GET
    • Install a plugin
      POST
    • Remove a plugin
      DELETE
    • Disable a plugin
      POST
    • Enable a plugin
      POST
    • Inspect a plugin
      GET
    • Push a plugin
      POST
    • Configure a plugin
      POST
    • Upgrade a plugin
      POST
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. Plugin

Inspect a plugin

/v1.33
/v1.33
/v1.33
/v1.33
GET
/plugins/{name}/json
Plugin
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/plugins//json'
Response Response Example
200 - Example 1
{
    "Config": {
        "Args": {
            "Description": "command line arguments",
            "Name": "args",
            "Settable": [
                "string"
            ],
            "Value": [
                "string"
            ]
        },
        "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"
            ]
        },
        "IpcHost": false,
        "Linux": {
            "AllowAllDevices": false,
            "Capabilities": [
                "CAP_SYS_ADMIN",
                "CAP_SYSLOG"
            ],
            "Devices": [
                {
                    "Description": "string",
                    "Name": "string",
                    "Path": "/dev/fuse",
                    "Settable": [
                        "string"
                    ]
                }
            ]
        },
        "Mounts": [
            {
                "Description": "This is a mount that's used by the plugin.",
                "Destination": "/mnt/state",
                "Name": "some-mount",
                "Options": [
                    "rbind",
                    "rw"
                ],
                "Settable": [
                    "string"
                ],
                "Source": "/var/lib/docker/plugins/",
                "Type": "bind"
            }
        ],
        "Network": {
            "Type": "host"
        },
        "PidHost": false,
        "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": {
        "Args": [
            "string"
        ],
        "Devices": [
            {
                "Description": "string",
                "Name": "string",
                "Path": "/dev/fuse",
                "Settable": [
                    "string"
                ]
            }
        ],
        "Env": [
            "DEBUG=0"
        ],
        "Mounts": [
            {
                "Description": "This is a mount that's used by the plugin.",
                "Destination": "/mnt/state",
                "Name": "some-mount",
                "Options": [
                    "rbind",
                    "rw"
                ],
                "Settable": [
                    "string"
                ],
                "Source": "/var/lib/docker/plugins/",
                "Type": "bind"
            }
        ]
    }
}

Request

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

Responses

🟢200no error
application/json
Body
A plugin for the Engine API
Config
object 
required
The config of a plugin.
Args
object 
required
Description
string 
required
Example:
A sample volume plugin for Docker
DockerVersion
string 
optional
Docker Version used to create the plugin
Example:
17.06.0-ce
Documentation
string 
required
Example:
https://docs.docker.com/engine/extend/plugins/
Entrypoint
array[string]
required
Example:
["/usr/bin/sample-volume-plugin","/data"]
Env
array[object (PluginEnv) {4}] 
required
Example:
[{"Description":"If set, prints debug messages","Name":"DEBUG","Settable":null,"Value":"0"}]
Interface
object 
required
The interface between Docker and the plugin
IpcHost
boolean 
required
Example:
false
Linux
object 
required
Mounts
array[object (PluginMount) {7}] 
required
Network
object 
required
PidHost
boolean 
required
Example:
false
PropagatedMount
string 
required
Example:
/mnt/volumes
User
object 
optional
WorkDir
string 
required
Example:
/bin/
rootfs
object 
optional
Enabled
boolean 
required
True if the plugin is running. False if the plugin is not running, only installed.
Example:
true
Id
string 
optional
Example:
5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078
Name
string 
required
Example:
tiborvass/sample-volume-plugin
PluginReference
string 
optional
plugin remote reference used to push/pull the plugin
Example:
localhost:5000/tiborvass/sample-volume-plugin:latest
Settings
object 
required
Settings that can be modified by users.
Args
array[string]
required
Devices
array[object (PluginDevice) {4}] 
required
Env
array[string]
required
Example:
["DEBUG=0"]
Mounts
array[object (PluginMount) {7}] 
required
🟠404plugin is not installed
🔴500server error
Modified at 2022-09-10 17:56:06
Previous
Enable a plugin
Next
Push a plugin
Built with