Plugin

Install a plugin

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

post/plugins/pull

Request

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

Query parameters

remotestring required

Remote reference for plugin to install.

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

namestring

Local name for the pulled plugin.

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

Headers

X-Registry-Authstring

A base64url-encoded auth configuration to use when pulling a plugin from a registry.

Refer to the authentication section for details.

Request body

Namestring

Descriptionstring

Valuestring[]

Example request

[
  {
    "Name": "network",
    "Description": "",
    "Value": [
      "host"
    ]
  },
  {
    "Name": "mount",
    "Description": "",
    "Value": [
      "/data"
    ]
  },
  {
    "Name": "device",
    "Description": "",
    "Value": [
      "/dev/cpu_dma_latency"
    ]
  }
]

Response

no error

Changes

No recorded changes to this operation across all 4 revisions of this API.