Install a plugin

/v1.33

POST

/plugins/pull

Plugin

Pulls and installs a plugin. After the plugin is installed, it can be enabled using the POST /plugins/{name}/enable endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.33/plugins/pull?remote=' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "Description": "",
        "Name": "network",
        "Value": [
            "host"
        ]
    },
    {
        "Description": "",
        "Name": "mount",
        "Value": [
            "/data"
        ]
    },
    {
        "Description": "",
        "Name": "device",
        "Value": [
            "/dev/cpu_dma_latency"
        ]
    }
]'

Response Example

204 - Example 1

{}

Request

Query Params

remote

string

required

Remote reference for plugin to install.

The :latest tag is optional, and is used as the default if omitted.

name

string

optional

Local name for the pulled plugin.

The :latest tag is optional, and is used as the default if omitted.

Header Params

X-Registry-Auth

string

optional

A base64-encoded auth configuration to use when pulling a plugin from a registry. See the authentication section for details.

Body Params application/json

array of:

Description

string

optional

Name

string

optional

Value

array[string]

optional

Examples

Responses

🟢204no error

application/json

Body

object {0}

🔴500server error

Modified at 2022-09-10 17:56:06

Get plugin privileges

Remove a plugin