You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.
Table of Contents

Module object

The following objects are directly related to the module API.


The module object has the following properties.

Property Type Description
moduleid ID ID of the module as stored in the database.

Property behavior:
- read-only
- required for update operations
id string Unique module ID as defined by a developer in the manifest.json file of the module.

Possible values for built-in modules:
see property "type" description in Dashboard widget.

Property behavior:
- required for create operations
relative_path string Path to the directory of the module relative to the directory of the Zabbix frontend.

Possible values:
widgets/* - for built-in widget modules;
modules/* - for third-party modules.

Property behavior:
- required for create operations
status integer Whether the module is enabled or disabled.

Possible values:
0 - (default) Disabled;
1 - Enabled.
config object Module configuration.