Install a plugin Run in API Explorer

POST /plugins/pull

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

Headers

  • X-Registry-Auth string

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

    Refer to the authentication section for details.

Query parameters

  • remote string Required

    Remote reference for plugin to install.

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

  • name string

    Local name for the pulled plugin.

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

application/json

Body

  • Name string
  • Description string
  • Value array[string]

Responses

  • 204

    no error

  • 500 application/json

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
POST /plugins/pull 
curl \
 --request POST 'http://api.example.com/v1.44/plugins/pull?remote=string' \
 --header "Content-Type: application/json" \
 --header "X-Registry-Auth: string" \
 --data '[{"Name":"network","Value":["host"],"Description":""},{"Name":"mount","Value":["/data"],"Description":""},{"Name":"device","Value":["/dev/cpu_dma_latency"],"Description":""}]'
Request examples 
# Headers
X-Registry-Auth: string

# Payload
[
  {
    "Name": "network",
    "Value": [
      "host"
    ],
    "Description": ""
  },
  {
    "Name": "mount",
    "Value": [
      "/data"
    ],
    "Description": ""
  },
  {
    "Name": "device",
    "Value": [
      "/dev/cpu_dma_latency"
    ],
    "Description": ""
  }
]
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}