Remove a plugin

/v1.33

DELETE

/plugins/{name}

Plugin

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.

Query Params

force

string

optional

Disable the plugin before removing. This may result in issues if the plugin is in use by a container.

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

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

Install a plugin

Disable a plugin