/ 
API-Docker-0.004
/ API::Docker::Type::Plugin

NAME

API::Docker::Type::Plugin - A plugin for the Engine API

VERSION

version 0.004

DESCRIPTION

Generated from the Plugin definition of spec/v1.51.yaml. Nothing in this class or in the ones hanging off it is backed by a measurement. Rootless Podman serves no plugin route at all, so on the engine this distribution measures against there is nothing here to observe; see "Not available on Podman" in API::Docker::API::Plugins. Everything below is read off the swagger's own examples.

id

Undocumented upstream. The plugin's own ID, a 64-character hex digest in the swagger's example. The /plugins/{name}/... endpoints address a plugin by "name", not by this.

name

Undocumented upstream. The plugin's reference, tiborvass/sample-volume-plugin in the swagger's example, and what the /plugins/{name}/... endpoints take in their path -- where the swagger notes the :latest tag is optional and the default when omitted. "plugin_reference" is the full remote reference the plugin was pushed or pulled under. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.

enabled

True if the plugin is running. False if the plugin is not running, only installed. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.

settings

Settings that can be modified by users. See API::Docker::Type::Plugin::Settings. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.

plugin_reference

Plugin remote reference used to push/pull the plugin.

config

The config of a plugin. See API::Docker::Type::Plugin::Config. The swagger lists this field as required; nothing here enforces that, see "since is documentation" in API::Docker::Type.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.