HEhexlet
Plugin

Upgrade a plugin

Changed on
post/plugins/{name}/upgrade

Request

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

Path parameters

namestring required

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

Query parameters

remotestring required

Remote reference to upgrade to.

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

  • 6df97b60796cRevision changes
    • breaking

      removed the request body

    • info

      api tag Plugin added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      request body became required

    • breaking

      removed the media type text/plain from the request body

    • info

      api tag Plugin removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status