** Copyright (C) 2001-2025 Zabbix SIA
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
** This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
** without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
** See the GNU Affero General Public License for more details.
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
"golang.zabbix.com/sdk/conf"
"golang.zabbix.com/sdk/errs"
"golang.zabbix.com/sdk/plugin"
// URI defines an endpoint to REST API.
URI string `conf:"name=Uri,optional"`
APIKey string `conf:"name=ApiKey"`
User string `conf:"name=User"`
type PluginOptions struct {
// InsecureSkipVerify controls whether an http client verifies the
// server's certificate chain and host name.
// If InsecureSkipVerify is true, TLS accepts any certificate
// presented by the server and any host name in that certificate.
// In this mode, TLS is susceptible to man-in-the-middle attacks.
// This should be used only for testing.
InsecureSkipVerify bool `conf:"optional,default=false"`
// KeepAlive is a time to wait before unused connections will be closed.
KeepAlive int `conf:"optional,range=60:900,default=300"`
// Sessions stores pre-defined named sets of connections settings.
Sessions map[string]Session `conf:"optional"`
// Timeout is the maximum time in seconds for waiting when a request has to be done.
// Default value equals to the global timeout.
Timeout int `conf:"optional,range=1:30"`
// Default stores default connection parameter values from configuration file
Default Session `conf:"optional"`
// Configure implements the Configurator interface.
// Initializes configuration structures.
func (p *Plugin) Configure(global *plugin.GlobalOptions, options interface{}) {
if err := conf.UnmarshalStrict(options, &p.options); err != nil {
p.Errf("cannot unmarshal configuration options: %s", err)
if p.options.Timeout == 0 {
p.options.Timeout = global.Timeout
// Validate implements the Configurator interface.
// Returns an error if validation of a plugin's configuration is failed.
func (p *Plugin) Validate(options interface{}) error {
err := conf.UnmarshalStrict(options, &opts)
return errs.Wrap(err, "plugin config validation failed")