Path parameters

• name string Required

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

Responses

• 200 application/json

  no error

  Hide response attributes Show response attributes object

  • Id string
  • Name string Required
  • Enabled boolean Required

    True if the plugin is running. False if the plugin is not running, only installed.

  • Settings object Required

    Settings that can be modified by users.

    Hide Settings attributes Show Settings attributes object

    • Mounts array[object] Required
      Hide Mounts attributes Show Mounts attributes object

      • Name string Required
      • Description string Required
      • Settable array[string] Required
      • Source string Required
      • Destination string Required
      • Type string Required
      • Options array[string] Required
    • Env array[string] Required
    • Args array[string] Required
    • Devices array[object] Required
      Hide Devices attributes Show Devices attributes object

      • Name string Required
      • Description string Required
      • Settable array[string] Required
      • Path string Required
  • PluginReference string

    plugin remote reference used to push/pull the plugin

  • Config object Required

    The config of a plugin.

    Hide Config attributes Show Config attributes object

    • DockerVersion string

      Docker Version used to create the plugin

    • Description string Required
    • Documentation string Required
    • Interface object Required

      The interface between Docker and the plugin

      Hide Interface attributes Show Interface attributes object

      • Types array[object] Required
        Hide Types attributes Show Types attributes object

        • Prefix string Required
        • Capability string Required
        • Version string Required
      • Socket string Required
      • ProtocolScheme string

        Protocol to use for clients connecting to the plugin.

        Values are or moby.plugins.http/v1.

    • Entrypoint array[string] Required
    • WorkDir string Required
    • User object
      Hide User attributes Show User attributes object

      • UID integer(uint32)
      • GID integer(uint32)
    • Network object Required
      Hide Network attribute Show Network attribute object

      • Type string Required
    • Linux object Required
      Hide Linux attributes Show Linux attributes object

      • Capabilities array[string] Required
      • AllowAllDevices boolean Required
      • Devices array[object] Required
        Hide Devices attributes Show Devices attributes object

        • Name string Required
        • Description string Required
        • Settable array[string] Required
        • Path string Required
    • PropagatedMount string Required
    • IpcHost boolean Required
    • PidHost boolean Required
    • Mounts array[object] Required
      Hide Mounts attributes Show Mounts attributes object

      • Name string Required
      • Description string Required
      • Settable array[string] Required
      • Source string Required
      • Destination string Required
      • Type string Required
      • Options array[string] Required
    • Env array[object] Required
      Hide Env attributes Show Env attributes object

      • Name string Required
      • Description string Required
      • Settable array[string] Required
      • Value string Required
    • Args object Required
      Hide Args attributes Show Args attributes object

      • Name string Required
      • Description string Required
      • Settable array[string] Required
      • Value array[string] Required
    • rootfs object
      Hide rootfs attributes Show rootfs attributes object

      • type string
      • diff_ids array[string]
• 404 application/json

  plugin is not installed

  Hide response attribute Show response attribute object

  • message string Required

    The error message.

• 500 application/json

  server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.