External API

From version NG 776 the PFMS API 2.0 is installed by default. In the case of using Ubuntu as the operating system of PFMS Server and upgrade to version 777 must be run and installed with root user or equivalent:

a2enmod rewrite
service apache2 restart

It is necessary to verify that the default configuration of the Apache web server when installing PFMS is correctly set.

By default, when installing Pandora FMS, the list of authorized IP addresses is restricted to local calls only (from localhost, 127.0.0.1). The IP address(es) that will work with the PFMS API 2.0 must be added in the General Web Console Configuration.

The authentication tokens for each user must be generated through the Web Console, menu Management → Profile → Token management → Create token where the user who will use this token, a description and an expiration date (recommended) will be selected. By clicking on the Create button, the token value will be displayed only once, it must be copied and saved in a secure location.

Once you have the token generated by the Web Console use the following link in the address bar of the web browser:

https://< IP address or FQDN >/pandora_console/api/

Click on the Authorize button and enter the previously generated token in the pop-up window.

When a token is set, the padlock icons will change and you can start making API requests. Such requests are classified into:

• POST: To create new elements.
• GET: To visualize the registered elements.
• PUT: To edit the registered elements.
• DELETE: To delete the registered elements.

In turn, logical groupings of actions are offered:

• Authentication: To manage API access tokens (always generate the first token through the Web Console).
• Events: For manage Pandora FMS events.
• Groups: To manage groups of PFMS agents.
• Profiles: To manage PFMS user profiles.
• Tags: To manage the PFMS tag system.
• Users: For manage PFMS users.
• PandoraITSM: To manage the inventory provided by Pandora ITSM to PFMS.

For this purpose, it is recommended to use curl, which is present in most current operating systems:

curl -X '< action >' \
  'http://< IP address or FQDN >/pandora_console/api/v2/< command >/< parameter >' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer < your token >'
  -d '< JSON parameters >'

Donde:

• < action > The action to be taken:

• POST: To create new elements.
• GET: To visualize the registered elements.
• PUT: To edit the registered elements.
• DELETE: To delete the registered elements.

• < command > The API command itself, such as ping, and so on.
• < parameter > A unique identifier or paging parameters, depending on each case.
• < your token > The token generated for each user.
• < JSON parameters > The rest of the parameters as required.

https://< IP address or FQDN >/pandora_console/api/v2/swagger.json

By accessing the above link you will get each and every feature of the documentation in an automated way, which allows you to generate documentation with any JSON compatible software.

In addition, in the web interface, each command has a link to its particular schema:

The easiest way to check connectivity and authentication with the PFMS API is done with its ping command:

curl -m 3 -X 'GET' \
  'http://192.168.7.117/pandora_console/api/v2/ping' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer < your token >' && echo 

In the web interface access the Authentication (API Endpoints of authentication) section and click the Try out button (if the lock icon is open click and enter the generated user token) and then click the Execute button. The connection will be successful if the code { “valid”: true } is displayed in the Response body:

The Pandora FMS External API is used doing remote calls (through HTTP or HTTPS) on the /include/api.php file. This is the method that has been defined in Pandora FMS to integrate applications from third parties to Pandora FMS. It basically consists on a call with the parameters formatted to receive a value or a list of values that after its application will be used to do operations.

The API call is structured as follows:

http://< Pandora FMS Console install >/include/api.php?< parameters >

The API can only receive the following parameters:

• op (required): It is the first parameter that specifies the nature of the operation, which could be get or set or help:
  • get: It returns a value or values.
  • set: It sends a value or values.
  • help: It returns a little help from the calls
• op2 (required): The call with an explanatory name of the one that it works on.
• id (depends on the command): The first call parameter.
• id2 (depends on the command): The second call parameter.
• other (depends on the command): The third call parameter, sometimes it could be a list of serial values.
• other_mode (depends on the command): Serial format, list of posible values:
  • url_encode: the othervalue is an alphanumeric formatted as UrlEncode.
  • url_encode_separator_<separator>:The value will be a serial value list with the divider character, for example:

...other=pears|melons|watermelon&other_mode=url_encode_separator_|

• returnType (depends on the command): return format of the value or values. Any of current available values:
  • string: It returns the value as it is as an alphanumeric one.
  • csv: It returns the values as a CSV separated with the ; character (fields) and with CR (files) by default.
  • csv_head: It returns the same as with csv, except that it adds a first file with the field names to return.
• Security credentials: see “Security” section.

The API authenticates access via API source and/or password and/or by_user_credentials#user credentials.

At the moment, security is based on an IP addresses list that will have access to the tool.

If you enter the character * in the box text, the ACL check will be omitted relegating the security to the protocol and to the environment.

You can also set a password for API actions (API password).

• apipass: By default, and used in this documentation, 1234.

Access is by user name and password; additionally from version 768 or later it is possible to authenticate by bearer token.

To access API actions, it is necessary to give a Pandora FMS valid user name and password.

• user: Valid Pandora FMS user; admin is used in this documentation.
• pass: The user password; pandora is used in this documentation.

When the API denies the access, the simple string auth error is returned.

In this documentation the API password 1234 is used, the user name is admin (superadmin type) and the user password is pandora.

See call syntax:

.../include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

• The source IP address is in the ACL IP addresses list (or is used *).
• The API password is not set or is 1234.
• The user admin exists and is a superadmin user, and its password is pandora.

Menu Management → Admin tools → API checker.

It is implemented thanks to three elements:

• Filtering by IP address: Only the listed IP addresses will be able to access the API.
• Global password for the API: If defined, it is mandatory to use it in all calls.
• User and password: User of type superadmin and valid in the Web Console. Your permissions will be used for each requested operation. From version NG 768 onwards it is also possible to access by bearer token.

It is explained in this workflow:

They are divided into two groups, depending on whether they return or write data in Pandora FMS.

There is an exception: The info retrieving call.

Authentication based on bearer token allows each of the users registered in Pandora FMS to generate their own identifier in one-to-one correspondence. This bearer token must be inserted in the HTTP headers, that is, it is not part of the complete URL of the API. The sending mechanism corresponds to the application that makes the connection with the PFMS API.

The following examples use the command line program cURL, version 7.68 .

• Check the curl version with curl -V.

• If you need more help using curl, invoke curl -h.
• The -k and -H parameters are used to accept connections with self-signed certificates for HTTPS and send header information, respectively.
• Consult the bearer token corresponding to the user who will perform the API query.
• Now you can perform an API query, the following example uses get test (replace with your previously queried bearer token):

BEARER="Authorization: Bearer 811a0c1889f3aa62ef481ccd173ea5ec"
URL="http://192.168.7.117/pandora_console/include/api.php"
API_QUERY="?op=get&op2=test"
curl -k -H "$BEARER" $URL$API_QUERY && echo ""

• If you need to debug the connection use the -v parameter (not to be confused with -V used to display the version).

It returns the version of Pandora FMS Console in a similar way as the get test call but without checking the API connection.

This call is useful to verify that this path allows a Pandora FMS installation and to retrieve the version before authentication.

The returned info can be retrieved from the login screen, so it is not considered a security vulnerability.

A return sample could be: Pandora FMS v7.0NG.777 - PC240610 MR69

It returns the required data.

It checks the connection to the API and returns the version of Pandora FMS Console.

Call syntax: Without parameters

Examples

This example will return OK,[version],[build]

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test&apipass=1234&user=admin&pass=pandora

A return sample could be: OK,v7.0NG.751,PC201215

To consult the Pandora FMS use licence status, depending on the access level of the user's credentials.

Call syntax:

• op=get (required).
• op2=license (required).
• return_type=json (required).

Example (see call syntax):

…/include/api.php?op=get&op2=license&return_type=json&apipass=1234&user=admin&pass=pandora

For the current version returns:

{
    "type": "array",
    "data": {
        "expiry_date": "2099/09/04",
        "limit": 200,
        "limit_mode": "0",
        "nms": "0",
        "dhpm": "1",
        "licensed_to": "PandoraFMS(PandoraFMS <[email protected]>)       ",
        "count": "4",
        "count_enabled": "4",
        "count_disabled": "0",
        "license_mode": "Perpetual",
        "expiry_caption": "Support expires"
    }
}

It returns a list of agent filters according to the filter in some other parameter.

Call syntax:

• op=get (required).
• op2=all_agents (required).
• return_type=csv or return_type=json (required).
• other=< serialized_parameters > (optional). Serialized parameters to filter the agent search:

• < filter_so >
• < filter_group >
• < filter_module_states > unknown, warning, critical, no_modules.
• < filter_alias >
• < filter_policy >
• < csv_separator >
• Recursion (1 or 0).

Examples (see call syntax):

This example will return all agents whose id_os is equal to 1 (CSV format):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1||||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This example will return all agents whose id_group equals 2 (JSON format):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=|2|||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This example will return all agents whose state equal to critical (CSV format):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||critical||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This example will return all agents whose their alias contains 'pa' (CSV format):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=|||pa|||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This example will return all agents whose the policy associated equals 2 (CSV format) and recursion:

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||||2||1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This example will return all agents whose id_os is equal to 1, id_group equals 2, state equal to critical, their alias contains 'pa', and the policy associated equals 2 (CSV format with @ separators):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1|2|critical|pa|2|@|0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

= 7.0NG 752

To check the number of Agents or Modules available according to the Pandora FMS use licence and according to the access level of the user credentials used.

Call syntax:

• op=get (required)
• op2= license_remaining (required)
• return_type=json (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=license_remaining&return_type=json&apipass=1234&user=admin&pass=pandora

Returns the last module value. This module is filtered by the ID which has gone through the id parameter. With the other parameter you may add an error code that your application knows and it is out of range of module values.

Call syntax:

• op=get (required)
• op2=module_last_value (required)
• id=<índex> (required). It should be an agent module index.
• other=<error return> (optional). What you wish to receive if there is an error(usually not located in the database).

• Error return codes are:

• 'error_message'. It returns an error in a text message.
• 'error_value'<separator><code or value>. It returns this code or error value. But it is necessary to enclose it with 'other_mode', like other_mode=url_encode_separator_<separador> to place the divider on another one.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62&apipass=1234&user=admin&pass=pandora

It returns the last module value. This module is filtered by the agent name which has gone through id parameter and module name which has gone through id2 parameter. With the other parameter, you may add an error code recognized by your application and which is out of range of module values.

Call Syntax:

• op=get (required)
• op2=agent_module_name_last_value (required)
• id=<alphanumeric>(required). It contains the agent name.
• id2=<alphanumeric> (required). It contains the module name.
• other=<error return> (optional). What you wish to receive if there is an error (that usually has not been found in the DB).

• Codes of error return are:

• 'error_message'. It returns error in a text message.
• 'error_value'<separator><code or value>. It returns this code or error value, but it must come with 'other_mode' such as other_mode=url_encode_separator_<separator> to use the divider on another one.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user&apipass=1234&user=admin&pass=pandora

⇒ 7.0NG

It returns the last module value. This module is filtered by the agent alias which has gone through id parameter and module name which has gone through parameter id2. With the other parameter, you may add an error recognized by your application and which is out range of module values.

Call Syntax:

• op=get (required)
• op2=module_last_value_alias (required)
• id=<alphanumeric>(required). It contains the agent alias.
• id2=<alphanumeric> (required). It contains the module name.
• other=<error return> (optional). What you wish to receive if there is an error ( that usually has not been found in the DB).

• Codes of error return are:

• 'error_message'. It returns error in a text message.
• 'error_value'<separator><code or value>. It returns this code or error value, but it must come with 'other_mode' such as other_mode=url_encode_separator_<separator> to use the divider on another one.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=pandorafms&id2=Memory_Used&apipass=1234&user=admin&pass=pandora

Given a module name, returns a list of agents containing that module name. The result returns the agent identifier, agent alias, requested module value and agent name, separated by semicolon (;). For example:

653;agente network;0.00000;a8c83b348451040dc91c1327303adf8945aefce6ac59ab9bf856c9f4e0cf6c6f

Call syntax:

• op=get (required).
• op2=module_value_all_agents (required).
• id=< module_name > (required).

Example (see call syntax):

A list of all the agents that have the module with Host Alive name:

.../include/api.php?op=get&op2=module_value_all_agents&id=Host%20Alive&apipass=1234&user=admin&pass=pandora

Returns the list of modules of an agent requested by its numerical identifier.

Syntax:

• op=get (required).
• op2=agent_modules (required).
• return_type=csv (required) Output format.
• other=< serialized values > (required) Serialized values in order to filter by agent:
• < id_agent >

Example (see call syntax):

.../include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It returns the id of an agent module.

Call syntax:

• op=get (required)
• op2=module_id (required)
• id=id agent (required)
• other=module name (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora

Returns the value of the Custom_id field of a specific module of an agent passing as parameter the module id.

Call syntax:

• op=get (required)
• op2=module_custom_id (required)
• id=id_agent_module (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_custom_id&id=5&apipass=1234&user=admin&pass=pandora

Changes or clears the value of the Custom ID field passing as parameters the module id and the value of the custom id.

Call syntax:

• op=set (required)
• op2=module_custom_id (required)
• id=id_agent_module (required)
• id2=value, or vacuum to clean (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_custom_id&id=5&id2=1521&apipass=1234&user=admin&pass=pandora

It gets the id server where the agent is located, and prints all the results like a csv.

Call syntax:

• op=get (required)
• op2=locate_agent (required)
• return_type=<csv> (required). Output format.
• id=id_agent (required)
• other_mode= other_mode=url_encode_separator_<separator> (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C

It returns the list of agent policies, whose id which has gone through the other parameter.

Call syntax:

• op=get (required)
• op2=policies (required)
• return_type=<csv> (required)
• other=<serialized values> (optional). Serialized values for filtering policies by policy agent:

• <id_agent>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It returns a complete list structured by the groups in the first level, agents in the second level and modules in the third level. This list is filtered by the other parameter.

Call Syntax:

• op=get (required)
• op2=tree_agents (required)
• return_type=<return kind> (required). That could be 'csv' or 'csv_head'.
• other=<string or serialized parameters> (optional). In this case, it could be the divider or a parameter list ordered and separated by the divider character. Both cases are described here:

• <separator> The divider yes of the csv.
• <separator csv>|<character that replaces the CR|<fields 1>,<fields 2>,<fields N>. It will place the following parameters in order (the divider character | could be specified in other_mode):

• <separator csv>. Field divider in the CSV.
• <character that replaces the CR>. Character that will be replaced if it finds in any returned character the character RC, in order to avoid the ambiguity with the standard use of the RC character to specify registers/files in the CSV. If you make an string go through other, the replacing character is the blank space.

• <fields 1>,<fields2>,<fields N> :the fields to show in the CSV are:
  • type_row
  • group_id
  • group_name
  • group_parent
  • disabled
  • custom_id
  • group_description
  • group_contact
  • group_other
  • agent_id
  • alias
  • agent_direction
  • agent_commentary
  • agent_id_group
  • agent_last_contact
  • agent_mode
  • agent_interval
  • agent_id_os
  • agent_os_version
  • agent_version
  • agent_last_remote_contact
  • agent_disabled
  • agent_id_parent
  • agent_custom_id
  • agent_server_name
  • agent_cascade_protection
  • agent_name
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (only in version 6.0SP1 or later)
  • module_warning_inverse (only in version 6.0SP1 or later)
  • alert_id_agent_module
  • alert_id_alert_template
  • alert_internal_counter
  • alert_last_fired
  • alert_last_reference
  • alert_times_fired
  • alert_disabled
  • alert_force_execution
  • alert_id_alert_action
  • alert_type
  • alert_value
  • alert_matches_value
  • alert_max_value
  • alert_min_value
  • alert_time_threshold
  • alert_max_alerts
  • alert_min_alerts
  • alert_time_from
  • alert_time_to
  • alert_monday
  • alert_tuesday
  • alert_wednesday
  • alert_thursday
  • alert_friday
  • alert_saturday
  • alert_sunday
  • alert_recovery_notify
  • alert_field2_recovery
  • alert_field3_recovery
  • alert_id_alert_template_module
  • alert_fires_min
  • alert_fires_max
  • alert_id_alert_command
  • alert_command
  • alert_internal
  • alert_template_modules_id
  • alert_templates_id
  • alert_template_module_actions_id
  • alert_actions_id
  • alert_commands_id
  • alert_templates_name
  • alert_actions_name
  • alert_commands_name
  • alert_templates_description
  • alert_commands_description
  • alert_template_modules_priority
  • alert_templates_priority
  • alert_templates_field1
  • alert_actions_field1
  • alert_templates_field2
  • alert_actions_field2
  • alert_templates_field3
  • alert_actions_field3
  • alert_templates_id_group
  • alert_actions_id_group'

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_name&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Returns a list of values of a module, this module is filtered by the id of module pass as id in the url. And the list of values is from the now to the period limit passed as second parameter into the other parameter, the first is the CSV separator.

Call syntax:

• op=get (required)
• op2=module_data (required)
• id=<id_modulo> (required)
• other_mode=url_encode_separator_<separator> (required)
• other=<serialized parameters> (optional)

• The CSV divider character (point by default)
• The period (in seconds)
• Start time (<year><month><day>T<hour>:<minute>)
• End time (<year><month><day>T<hour>:<minute>)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Returns the chart of a module as an image file, this chart is generated with the same method of static graphs of Pandora FMS. It is necesary to include the width, height, period, label and start date of chart (knowing in Pandora FMS the date indicated in graphs is always the data end) into the other parameter.

Call syntax:

• op=set (required)
• op2=module_data (required)
• id=<id_modulo> (required)
• other=<serialized parameters> (required). They are the following in this order:

• <period>
• <width>
• <height>
• <label>
• <start_date>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|pepito|2009-12-07&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It returns a list of events filtered by the other parameter.

Call syntax:

• op=get (required).
• op2=events (required).
• id=< id_node > (optional in Command Center -Metaconsole-, unnecessary in node).
• return_type=csv or return_type=json (required).
• other_mode=url_encode_separator_| (required).
• other=< serialized parameters > (optional), are the following in this order:
  1. < separator > (required).
  2. < criticality > any of the following values from 0 to number 6:
     1. 0:Maintenance
     2. 1:Informational
     3. 2:Normal
     4. 3:Warning
     5. 4:Critical
     6. 5:Minor
     7. 6:Major
  3. < agent alias >
  4. < module name >
  5. < filter by alert > use 1 to filter events generated by alerts.
  6. < event owner user >
  7. < minimum date and time (since) > in Unix® time format, without milliseconds (EPOCH).
  8. < maximum date and time (until) > in Unix® time format, without milliseconds (EPOCH).
  9. < state > 0 to filter non-validated events, 1 for validated events.
  10. < text > keyword to search for in the events.
  11. < page size > sets the number of records to return for pagination (offset). If the offset number is omitted, it will only return the first offset (the first offset is the number zero 0).
  12. < page number > according to the page size of the previous point, returns earlier or later record blocks (offset).
  13. < style > only accepts two key values:
      1. total: it simply returns the total number of events, for example in JSON format delivers: {“type”:“json”,“data”:{“count”:990}}.
      2. more_criticity: returns the number of most critical events, for example if requested in JSON format: {“type”:“json”,“data”:[{“criticity”:“4”,“user_can_manage”:“1”,“user_can_write”:“1”,“server_id”:5,“server_name”:“stod”}]}.
  14. < group_id > returns non-validated events belonging to a group of agents, use numeric values only.
  15. < tag > any of the tags registered in PFMS (see get tags ). JSON format required, for example: [“2”,“5”] (see call syntax).
  16. < event type > any of the following values:
      • going_unknown
      • unknown
      • recon_host_detected
      • system
      • error
      • new_agent
      • going_up_warning
      • going_up_critical
      • going_down_warning
      • going_down_normal
      • going_down_critical
      • going_up_normal
      • configuration_change
      • ncm
      • not_normal

Example (see call syntax):

To obtain the ncm (Network configuration manager) events by querying a Command Center (Metaconsole) whose node is 5:

…include/api.php?op=get&op2=events&user=admin&pass=pandora&return_type=json&apipass=1234&other_mode=url_encode_separator_|&other=|||||||||||||||ncm&id=5

It returns the list of alert templates defined in Pandora FMS.

Call syntax:

• op=get (required)
• op2=all_alert_templates (required)
• other=cvs_separator (optional)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

It returns the list of module groups.

Call syntax:

• op=get (required)
• op2=module_groups (required)
• other=cvs_separator (optional)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

It returns the list of Pandora FMS server plugins.

Call syntax:

• op=get (required)
• op2=plugins (required)
• other=cvs_separator (optional)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

It returns the list of tags defined in Pandora FMS.

Call syntax:

• op=get (required)
• op2=tags (required)
• return_type=csv or return_type=json (required)
• other=< field separator > if you request in CSV format you must specify separator, otherwise it will return the fields together.

Example (see call syntax):

This example will return all tags in the system in CSV format with semicolon separator.

…/include/api.php?op=get&op2=tags&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

It returns the configuration of a local module.

Call syntax:

• op=get (required)
• op2=update_module_in_conf (required)
• id=<agent id> (required)
• id2=<module name> (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name

It returns an empty string if no modules are found.

Total modules by group.

Call syntax:

• op=get (required).
• op2=total_modules (required).
• id=< id group > (required up to version 768; optional from version 769 onwards).

Examples (see call syntax)

To obtain the total number of modules in the Networking module group:

.../include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora

The following groups of modules come by default when installing Pandora FMS:

1. General.
2. Networking.
3. Application.
4. System.
5. Miscellaneous.
6. Performance.
7. Database.
8. Enviromental.
9. Users.

If you set 0 as group id, or simply omit it, it will return the total number of modules:

.../include/api.php?op=get&op2=total_modules&apipass=1234&user=admin&pass=pandora

Total agents by group.

Call syntax:

• op=get (required)
• op2=total_agents (required)
• id=<id group> (required)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora

Agent name for a given id

Call syntax:

• op=get (required)
• op2=agent_name (required)
• id=<agent id> (required)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora

= 7.0NG

Agent alias for a given id.

Call syntax:

• op=get (required)
• op2=agent_alias (required)
• id=<agent id> (required)
• id2=<node id> (required in the meta console, unnecessary in the node)

Examples

• Node:

http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora

• Command Center (Metaconsole):

http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora

Module name for a given id.

Call syntax:

• op=get (required)
• op2=module_name (required)
• id=<module id> (required)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora

Total alert execution with an action by group.

Call syntax:

• op=get (required)
• op2=alert_action_by_group (required)
• id=<group id> (required)
• id2=<action id> (required)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora

List all alert actions.

Call syntax:

• op=get (required).
• op2=alert_actions (required).
• return_type=< list_format > choice csv or json (required).
• other=< serialized parameter > (optionals):
  • < action_name >
  • < separator >

Examples:

To get the list of all alert actions in JSON format (see call syntax):

.../include/api.php?op=get&op2=alert_actions&return_type=json&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

To get the list of all alert actions in CSV format (see call syntax):

.../include/api.php?op=get&op2=alert_actions&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

List of node alert actions from Command Center (Metaconsole).

Call syntax:

• op=get (required)
• op2=alert_actions_meta (required)
• return_type=<return type> (required). It can be 'csv' o 'json'.
• other=<serialized parameters> (optional):

• <server_name> (optional)
• <action_name> (optional)
• <separator> (optional)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json

It returns all the alert commands.

Call syntax:

• op=get (required)
• op2=all_alert_commands (required)
• other=cvs_separator(optional)

Examples

http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora

It returns all event data by typing in the event id.

Call syntax:

• op=get (required)
• op2=event_info (required)
• id=<id_event> (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora

It returns the following value list (this values can be seen in the tactical page in Pandora FMS Console)

• monitor_checks
• monitor_not_init
• monitor_unknown
• monitor_ok
• monitor_bad
• monitor_warning
• monitor_critical
• monitor_not_normal
• monitor_alerts
• monitor_alerts_fired
• monitor_alerts_fire_count
• total_agents
• total_alerts
• total_checks
• alerts
• agents_unknown
• monitor_health
• alert_level
• module_sanity
• server_sanity
• total_not_init
• monitor_non_init
• agent_ok
• agent_warning
• agent_critical
• agent_unknown
• agent_not_init
• global_health

Call syntax:

• op=get (required)
• op2=tactical_view (required)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora

= 5.0

It returns the list of Pandora FMS servers.

Call syntax:

• op=get (required)
• op2=pandora_servers (required)
• other=cvs_separator (optional)
• return_type=csv (required)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora

It returns the fields in this order:

• name
• status (1 - up, 0 - down)
• type (human readable string)
• master (1 - master, 0 - not master)
• running modules
• total modules
• max delay (sec)
• delayed modules
• threads
• queued_modules
• timestamp of update (human readable string)

It translates the name of the custom field into the ID it has in the data base.

Call syntax:

• op=get (required).
• op2=custom_field_id (required).
• other=< parameter > (required) In this case, custom field name.

Example (see call syntax):

…/include/api.php?op=get&op2=custom_field_id&other=Serial%20Number&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 5.0

It returns the last GIS agent data.

Call syntax:

• op=set (required)
• op2=gis_agent (required)
• id=<index> (required). It must be an agent index.

Example

http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1

= 5.1

It returns special day's list.

Call syntax:

• op=get (required)
• op2=special_days (required)
• other=<csv separator> (optional). CSV separator

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=special_days

= 5.1SP2

It returns a list of module properties. The list could be filtered by parameter.

Call Syntax:

• op=get (required)
• op2=module_properties (required)
• id=module-id (required)
• return_type=<return kind> (required). That could be csv or csv_head.
• other=<string or serialized parameters> (optional). In this case, it could be the divider or a parameter list ordered and separated by the divider character. Both cases are exposed:

• <separator>. The divider yes of the csv.
• <separator csv>|<. Character that replaces the CR|<fields 1>,<fields 2>,<fields N>. It will make up the following parameters in order (the divider character | could be specified in other_mode):

• <separator csv>. Field divider in the CSV.
• <character that replaces the CR>. Character that will be replaced if it finds in any returned character the character RC, in order to avoid the ambiguity with the standard use of the RC character to specify registers/files in the CSV. If you make a string go through other, the replacing character is the blank space.
• <fields 1>,<fields2>,<fields N>. The fields to output in CSV are:
  • module_id_agent_module
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (only in version 6.0SP1 or later)
  • module_warning_inverse (only in version 6.0SP1 or later)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 5.1SP2

It returns a list of module properties. The list could be filtered by parameter.

Call Syntax:

• op=get (required)
• op2=module_properties_by_name (required)
• id=agent_name (required)
• id2=agentmodule_name (required)
• return_type=<return kind> (required). That could be 'csv' or 'csv_head'.
• other=<string or serialized parameters> (optional). In this case, it could be the divider or a parameter list in order and separated by the divider character. (the same as 'get module_properties'. For details, see 'get module_properties')

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 7.0NG

It returns a list of module properties. The list could be filtered by parameter.

Call Syntax:

• op=get (required)
• op2=module_properties_by_alias (required)
• id=agent_alias (required)
• id2=agentmodule_name (required)
• return_type=<return kind> (required). That could be 'csv' or 'csv_head'.
• other=<string or serialized parameters> (optional). In this case, it could be the divider or a parameter list ordered and separated by the divider character (the same as 'get module_properties'. For details, see 'get module_properties').

Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

It returns a Module graph encoded with base64..

Call Syntax:

• op=get (required)
• op2=module_graph (required)
• id=<module id> (required)
• other=<period in seconds> (optional) 3600 by default (1 hour). Period of time used in the data recovery.

From version NG 752 onwards, more parameters are available, please pay attention to the mandatory fields and their separators | or its Escape character %7C .

• op=get (required)
• op2=module_graph (required)
• id=<module id> (required)
• other=
  • Time range in seconds (default 3600 ) in which data will be collected from the date of the request backwards (required).
  • Separator.
  • 0 for base64 graphics, 1 for image (required).
  • Separator.
  • 0 without thresholds, 1 with thresholds - if the Module has active thresholds - (required).
  • Separator.
  • Height of the graph, in pixels (required). Additionally it needs 49 pixels to display the map keys.

Examples Prior to version NG 752:

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora

Version NG 752 or higher:

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=2&other=3600%7C1%7C1%7C500%7C&other_mode=url_encode_separator_%7C|&apipass=1234&api=1&user=admin&pass=pandora

= 5.1

It returns all matches of planned downtime.

op=get op2=all_planned_downtimes return_type=csv other=<name> <group> <type_downtime> <type_execution> <type_periodicity> (for filtering)

Example

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

= 5.1

It returns all matches of planned downtime items.

op=get op2=planned_downtimes_items return_type=csv other=<name> <group> <type_downtime> <type_execution> <type_periodicity> (for filter)

Example

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

= 5.1

It returns the group id of an agent.

Call Syntax:

• op=get
• op2=id_group_agent_by_name
• other=<string or serialized parameters>. Agent name and filtering parameters (optional).
  • <agent_name>

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

= 7.0NG

It returns the group id of an agent.

Call Syntax:

• op=get
• op2=id_group_agent_by_alias
• other=<string or serialized parameters>. Agent alias and filtering parameters (optional)
  • <agent_alias>

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

= 5.1

It returns the group name for a agent.

Call Syntax:

• op=get
• op2=group_agent_by_name
• other=<string or serialized parameters> Agent name and filtering parameters (optional).
  • <agent_name>

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

= 7.0NG

It returns the group name for an agent.

Call Syntax:

• op=get
• op2=group_agent_by_alias
• other=<string or serialized parameters>. Agent alias and filtering parameters (optional).
  • <agent_alias>

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

= 7.0NG

It returns the group id from the name.

Call syntax:

• op=get
• op2=group_id_by_name
• other=<unique parameter> (required):
  • <group_name>

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers

= 7.0NG

It returns the timezone with which pandora is configured.

Call syntax:

• op=get
• op2= timezone

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone

= 7.0

It returns the cluster status by id

• op=get
• op2=cluster_status
• id=cluster id

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora

= 7.0

It returns the id of the cluster by name

• op=get
• op2=cluster_id_by_name
• id=cluster name

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

It returns the id ⇒ cluster agents names by cluster id

• op=get
• op2=agents_id_name_by_cluster_id
• id=cluster id

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

= 7.0 It returns the id ⇒ cluster agents names by cluster name

• op=get
• op2=agents_id_name_by_cluster_name
• id=cluster id

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

It returns the id ⇒ all the module names of the cluster agents by cluster id

• op=get
• op2=modules_id_name_by_cluster_id
• id=cluster id

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

= 7.0

It returns the id ⇒ all the module names of the cluster agents by cluster name

• op=get
• op2=modules_id_name_by_cluster_name
• id=cluster name

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=paco&apipass=1234&user=admin&pass=pandora

= 7.0

It returns the items of a json object with the format: item id ⇒ (name,id,module_agent,type,pcrit,pwarn), by cluster id

pcrit: % for the critic state if its AA or 1 o 0 if its AP

pwarn: % for the warning state if its AA or null if its AP

• op=get
• op2=cluster_items
• id=cluster id

 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora

= 7.0NG. 725

It returns all data from a policy. If no policy id is specified, it will return all data from all policies.

Call syntax:

• op=get
• op2=policy
• id=id_policy (optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

It returns all policy colections. If no policy id is specified, it returns all policy colections.

Call syntax:

• op=get
• op2=collections_policy
• id=id_policy (optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

It returns all policy plugins. If no policy id is specified, it returns all policy plugins.

Call syntax:

• op=get
• op2=plugins_policy
• id=id_policy (optional)
• return_type=(json, csv, string).

Example

http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

It returns all inventory modules of a policy. If no policy id is specified, it returns all inventory modules of all policies.

Call syntax:

• op=get
• op2=inventory_policy
• id=id_policy (optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

= 7.0NG. 725

It returns all unlinked modules of a policy. If no policy id is specified, it returns all unlinked modules of all policies.

Call syntax:

• op=get
• op2=unlinking_policy
• id=id_policy(optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

It returns the alerts of a policy, taking into account:

• If a policy id is specified, it returns the alerts of that policy. If not, it returns all alerts of all policies.
• If the type of alert is specified: (three options).
  • 0: it shows all by default.
  • 1: Shows only the normal alerts.
  • 2: Shows only the external alerts.

Call syntax:

• op=get
• op2=alerts_policy
• id=id_policy(optional)
• id2=0:all(by default), 1:normal, 2:external.
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.

= 7.0NG. 725

It returns all actions of the alerts of a policy, taking into account:

• If a policy id is specified, it returns the actions of the alerts of that policy. If not, it returns all the actions of all the alerts of all policies.
• If an alert id is specified, it returns the action of that alert.

Call syntax:

• op=get
• op2=alerts_actions_policy
• id=id_policy(optional)
• id2=id_policy_alert(optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3

= 7.0NG. 725

It returns all policy agents. If no policy id is specified, it returns all agents of all policies.

Call syntax:

• op=get
• op2=agents_policy
• id=id_policy(optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

= 7.0NG. 725

It returns all groups of a policy. If no policy id is specified, it returns all groups of all policies.

Call syntax:

• op=get
• op2=groups_policy
• id=id_policy(optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

= 7.0NG. 725

It returns the queue of a policy. If no id policy is specified, its returns all queues of all policies.

Call syntax:

• op=get
• op2=queue_policy
• id=id_policy(optional)
• return_type=(json, csv, string)

Example

http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json

= 7.0NG. 728

It returns the specified source traps, they can also be filtered by timestamp and other data.

Call syntax:

• op=get
• op2=traps
• other=<optional parameters>
  • <timestamp>
  • <limit>
  • <offset>
  • <status>
  • <oid_custom>

Example

https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It returns the response list of events the user has access to in Pandora FMS.

Call syntax:

• op=get (required)
• op2=event_reponses (required)
• return_type=csv|json (required)

Example

This example will return all system event responses in csv format.

http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora

Returns a list of users registered on a Pandora FMS server.

Call syntax:

• op=get (required).
• op2=users (required).
• return_type=csv o return_type=json (required).

Example (vea call syntax):

Return all system users in CSV format.

…/include/api.php?op=get&op2=users&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It lists all Pandora FMS users.

Call syntax:

• op=get (required)
• op2=list_all_user(required)
• return_type=csv|json (required) Example

It can return Json or CSV, this return is remarked through the URL. Only the type of return is remarked, it does not use any specific variable

http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora

It lists user data.

Call syntax:

• op=get (required)
• op2=list_all_user(required)
• return_type=csv|json (required)
• other= usernarme (requiered)

Example

It obtains all the information about a specific user. It can return Json or CSV. This return is specified through the URL. Only the username is used to obtain said information:

http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It returns the list of Pandora FMS user profiles.

Call syntax:

• op=get (required)
• op2=user_profiles_info (required)
• return_type=csv|json (required)

Example

This example will return all user profiles in json format.

http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=csv&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_&

= 7.21 ONLY METACONSOLE

It looks up whether an especific agent exists in migration queue, returning the data of migration_queue.

• op=get
• op2=migrate_agent
• id=id_agente a migrar
• return_type=string, json, etc

Example

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json

= 7.0NG 730

It returns the language with which Pandora FMS is configured.

Call syntax:

• op=get
• op2=language

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language

= 7.0NG 730

It returns the session time with which Pandora FMS is configured.

Call syntax:

• op=get
• op2=session_timeout

Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout

= 7.0NG 732

It returns the existing groups.

Call syntax:

• op=get
• op2=groups
• other=<optional parameters>:

• <csv_separator>: ';' by default.
• <return_all_group>. It returns the group 'All'.
• <return_all_columns>. It returns all columns.

Example

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It obtains user groups through filtering.

Call syntax:

• op=get (requiered)
• op2=filter_user_group (requiered)
• return_type=csv|json(requiered)
• other= id group(requiered)|Enabled or not(Disabled)(requiered)

Example

It can return Json or CSV. This return is remarked through the URL.

http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It returns the list of Pandora inventory modules.

Call syntax:

• op=get (required)
• op2=inventory_modules (required)
• return_type=csv|json (required)

Examples

This example will return information from all of the system's inventories in json format.

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora

Obtains the inventory modules from an agent using the agent name.

Call syntax:

• op=get (required)
• op2=inventory_modules_by_name (required)
• id=<agent name> (required)

Examples

http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_name&id=name&return_type=csv&apipass=1234&user=admin&pass=pandora

Obtains the inventory modules from an agent using the agent alias.

Call syntax:

• op=get (required)
• op2=inventory_modules_by_alias (required)
• id=<agent alias> (required)

Examples

http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_alias&id=alias&return_type=csv&apipass=1234&user=admin&pass=pandora

Obtains the data from an inventory module using agent name and module.

Call syntax:

• op=get (required)
• op2=inventory_module_data (required)
• id=<agent name> (required)
• id2=<inventory module name> (optional)
• other=<serialized parameters> (optional), the following ones in this order:
  • <separator>
  • <date_from>: <year><month><day>T<hour>:<minute>
  • <date_to>: <year><month><day>T<hour>:<minute>
  • <use_agent_alias> (optional) values 0 and 1.

Examples

http://127.0.0.1/pandora_console/include/api.phpop=get&op2=inventory_module_data&id=e14ae3b959b08a1fb7a057281401a08063cf04eb714efa5fbf1cf4043cfa1314&id2=Routes&other=,%7C20191010T13:40%7C20191211T13:40%7C0&return_type=csv&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It returns the list of all the collections in Pandora FMS.

Call syntax:

• op=get (required)
• op2=list_collections (required)

Examples

This example will return information from all collections in json format.

http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora

It returns the list of all files in a collection. If it does not receive a collection id, it will return all files from all collections.

Call syntax:

• op=get (required)
• op2=list_collections_files (required)
• id=id_collection

Examples

This example will return the names of all files in a collection in json format.

http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora

It returns the ID of the events in the Command Center (Metaconsole), using the ID of the node and the ID of the event from the node.

Call syntax:

• op=get (required)
• op2=event_mcid (required)
• id=<server_id> (required) the ID of one of the nodes.
• id2=<id_source_event> (required) The ID of the event from the node.

Example

http://172.16.0.3/pandora_console/include/api.php?op=get&op2=event_mcid&return_type=json&id=0&id2=0&apipass=1234&user=admin&pass=pandora

Returns whether a node is centralized ( 1 ) or not ( 0 ). If the node does not exist it will return a text string informing about it. It can be used in Command Center (Metaconsole) or directly in the node.

Call syntax:

• op=get (required).
• op2=is_centralized (required).
• id=(required for Command Center (Metaconsole), no need for node).

Example at node:

 http://localhost/pandora_console/include/api.php?op=get&op2=is_centralized&apipass=1234&user=admin&pass=pandora

Example at Command Center (Metaconsole):

http://localhost/pandora_console/include/api.php?op=get&op2=is_centralized&id=3&apipass=1234&user=admin&pass=pandora

It sends data.

It creates a new agent with the data sent as parameters.

Call syntax:

• op=set (required).
• op2=new_agent (required).
• id= (Command Center (Metaconsole)) Numerical identifier of the node to which the agent will belong (required).
• other=<serialized parameters> (required). They are the agent configuration and data, serialized in the following order:
  • <agent_alias>
  • <ip>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <cascade_protection_module>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>
  • <alias_as_name>

Examples

Call example for node (see call syntax ):

.../include/api.php?op=set&op2=new_agent&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Call example for Command Center (Metaconsole) (see call syntax):

.../include/api.php?op=set&op2=new_agent&id=1&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

• Note: If <alias_as_name> is 1, the agent name will be the same as the alias. If it is 0, the agent name will be automatically generated.

It updates an agent with data as parameters.

Call syntax:

• op=set (required)
• op2=update_agent (required)
• id=<id_agent> (required)
• other=<serialized parameters> (required). They are agent configuration and data, serialized in the following order:
  • <agent_alias>
  • <ip_address>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <cascade_protection_module>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>
  • <os_version>

Example (see call syntax):

.../include/api.php?op=set&op2=update_agent&id=5&other=agent_name%7C1.1.1.1%7C0%7C4%7C0%7C0%7C30%7C8%7Clocalhost.localdomain%7C%7C0%7C0%7Cla%20description|Ubuntu&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

This call updates the field(s) of one or more Agents (the latter if it uses aliases and there are several matching ones.

Call syntax:

• op=set (required)
• op2=update_agent (required)
• id=<id_agent> or <alias> (required), <alias> depends of id2 parameter.
• id2= <0> if is<id_agente> (opcional), <1> if is <alias> (required).
• other=<serialized parameters> (required). They are agent configuration and data, serialized in the following order:

• <agent_alias>
• <ip>
• <id_parent>
• <id_group>
• <cascade_protection>
• <cascade_protection_module>
• <interval_sec>
• <id_os>
• <name_server>
• <custom_id>
• <learning_mode>
• <disabled>
• <description>

Examples

In case of using the Agent's identifier:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

In case of using aliases, it modifies all the agents that contain that alias:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=pandora&id2=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It deletes an agent that has the name as parameter.

Call syntax:

• op=set (required)
• op2=delete_agent (required)
• id=<name_agent> (required). It should be an agent name.
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora

It creates an alert from a template as id parameter, in a module chosen by the module id agent id in other.

Call syntax:

• op=set (required)
• op2=create_module_template (required)
• id=<id_template> (required). It should be a template id.
• other=<id_module>|<id_agent>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It applies module template to agent.

Module template is an group which contains network check modules. These templates can be applied directly to agents, avoiding adding modules one by one.

Call Syntax:

• op=set (required)
• op2=apply_module_template (required)
• id<id_template> (required). Id of the template that will be applied on the module.
• id2<id_agente> (required). Id of the agent in which the modules will be created.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora

It creates a network module from data as parameters.

Call syntax:

• op=set (required).
• op2=create_network_module (required).
• id=< agent_name > (required). It should be an agent name.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < enable_unknown_events >
24. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
25. < each_ff >
26. < ff_threshold_normal >
27. < ff_threshold_warning >
28. < ff_threshold_critical >
29. < critical_inverse >
30. < warning_inverse >
31. < ff_type >
32. < ignore_unknown > Accepts values 0 and 1.
33. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

…/include/api.php?op=set&op2=create_network_module&id=example&other=test|0|7|1|10|15|0|16|18|0|15|0|127.0.0.1|0||0|180|0|0|0|0|latency%20ping|1|||||||||||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates a module plugin with data as parameters.

Call syntax:

• op=set (required).
• op2=create_plugin_module (required).
• id=< agent_name > (required). It should be an agent name.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < id_plugin >
24. < plugin_user >
25. < plugin_pass >
26. < plugin_parameter >
27. < enable_unknown_events >
28. < macros > The values must be in base 64 encoded JSON format.
29. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical >
34. < critical_inverse >
35. < warning_inverse >
36. < ff_type >
37. < use_agent_alias > Accepts values 0 and 1.
38. < ignore_unknown > Accepts values 0 and 1.
39. < number_of_intervals_in_warning > Enables state scaling by specifying the maximum number of consecutive intervals in which the module remains in the warning state. Exceeding this value will escalate the module to critical state.

Example (see call syntax):

…/include/api.php?op=set&op2=create_plugin_module&id=example&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|4|2|admin|pass|-p%20max||||||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

The content of the JSON document must be an object composed of several objects with the following properties:

• macro: Macro name. It should be _field1_, _field2_, …, _fieldN_.
• desc: Descriptive macro name.
• help: Macro description.
• value: Macro value.
• hide: Set to 1 to hide the macro value (useful for storing passwords).

Example:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1",
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80",
   "hide": ""
 }
}

It creates a module with the given parameters.

Call syntax:

• op=get (required).
• op2=create_data_module (required)
• id=< agent_name > (required). It should be an agent name.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < description >
5. < id_module_group >
6. < min_value >
7. < max_value >
8. < post_process >
9. < module_interval >
10. < min_warning >
11. < max_warning >
12. < str_warning >
13. < min_critical >
14. < max_critical >
15. < str_critical >
16. < history_data >
17. < enable_unknown_events >
18. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “< macro name >”: “< macro value >”.
19. < ff_threshold >
20. < each_ff >
21. < ff_threshold_normal >
22. < ff_threshold_warning >
23. < ff_threshold_critical >
24. < ff_timeout >
25. < critical_inverse >
26. < warning_inverse >
27. < ff_type >
28. < ignore_unknown > Values 0 and 1 supported.
29. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

…/include/api.php?op=set&op2=create_data_module&id=test&other=test2|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0|||||||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates an SNMP module.

Call syntax:

• op=set (required).
• op2=create_snmp_module (required).
• id=< agent_name > (required). It should be an agent name.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < module_port >
15. < snmp_version >
16. < snmp_community >
17. < snmp_oid >
18. < module_interval >
19. < post_process >
20. < min_value >
21. < max_value >
22. < custom_id >
23. < description >
24. < snmp3_priv_method [AES|DES] >
25. < snmp3_priv_pass >
26. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
27. < snmp3_auth_method [MD5|SHA] >
28. < snmp3_auth_user >
29. < snmp3_auth_pass >
30. < enable_unknown_events >
31. < each_ff >
32. < ff_threshold_normal >
33. < ff_threshold_warning >
34. < ff_threshold_critical >
35. < ff_type >
36. < ignore_unknown > Accepts values 0 and 1.
37. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

First example (snmp v: 1):

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=test5|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP%20module%20from%20API||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Second example (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: example_user, snmp3_auth_pass: example_priv_passw):

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=test7|0|15|1|10|15||16|18||15|0|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP%20module%20from%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw|||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates the network module.

Call syntax:

• op=get (required).
• op2=update_network_module (required).
• id=< id_modulo > (required) It should be a module id (tagente_modulo).
• other=< serialized parameters > (required) They are module configuration and data, serialized in the following order:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < min_ff_even >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < disabled_types_event >
24. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
25. < each_ff >
26. < ff_threshold_normal >
27. < ff_threshold_warning >
28. < ff_threshold_critical >
29. < critical_inverse >
30. < warning_inverse >
31. < ff_type >
32. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

…/include/api.php?op=set&op2=update_network_module&id=132&other=|0|6|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates the plugin module.

Call syntax:

• op=set (required).
• op2=update_plugin_module (required).
• id=< module_id > (required). It should be a module id.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < ip_target >
13. < tcp_port >
14. < snmp_community >
15. < snmp_oid >
16. < module_interval >
17. < post_process >
18. < min_value >
19. < max_value >
20. < custom_id >
21. < description >
22. < id_plugin >
23. < plugin_user >
24. < plugin_pass >
25. < plugin_parameter >
26. < disabled_types_event >
27. < macros > Values must be in base 64 encoded JSON format.
28. < module_macros > The format of the JSON properties should be “<macro name>”: “<macro value>”. See example at the end of this section.
29. < each_ff >
30. < ff_threshold_normal >
31. < ff_threshold_warning >
32. < ff_threshold_critical >
33. < critical_inverse>
34. < warning_inverse>
35. < policy_linked >
36. < ff_type >
37. < ignore_unknown > Accepts values 0 and 1.
38. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

…/include/api.php?op=set&op2=update_plugin_module&id=2343&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|pluginmodule%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

The content should be an object made up by objects with the following properties:

• “macro”: Macro name. Should be _field1_, _field2_, …, _fieldN_.
• “desc”: Descriptive name of the macro.
• “help”: Macro description.
• “value”:Macro value.

JSON macro format example:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

Another example with state scaling:

…/include/api.php?op=set&op2=update_plugin_module&id=135&other=|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max|||||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates the local module.

Call syntax:

• op=set (required).
• op2=update_data_module (required).
• id=< id_module_agent > (required) module's numeric ID to update.
• other=< serialized parameters > (required) module data and module configuration in serialized order:

1. < id_agent >
2. < disabled > use 1 for disable, 0 for no changes.
3. < description >
4. < id_module_group > see get_module_groups.
5. < min >
6. < max >
7. < post_process > ( Only for Software Agents with remote configuration enabled).
8. < module_interval >
9. < min_warning >
10. < max_warning >
11. < str_warning >
12. < min_critical >
13. < max_critical >
14. < str_critical >
15. < history_data > If it is set at 0, module data will not be saved at tagente_datos, only tagent_estado will be updated.
16. < disabled_types_event > JSON forma, example: {“going_unknown”:1} .
17. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
18. < min_ff_event > Number of times a change of state condition has to occur before the change of state can take place (flipflop ).
19. < each_ff >
20. < min_ff_event_normal >
21. < min_ff_event_warning >
22. < min_ff_event_critical >
23. < ff_timeout >
24. < critical_inverse >
25. < warning_inverse >
26. < policy_linked >
27. < ff_type >
28. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

.../include/api.php?op=set&op2=update_data_module&id=123&other=|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0||||||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates a data module in a policy and returns an id from the new module.

Call syntax:

• op=set (required).
• op2=update_data_module_policy (required).
• id=< id_policy > (required). Numeric identification of the target policy.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < id_policy_module >
2. < description >
3. < id_module_group >
4. < min >
5. < max >
6. < post_process >
7. < module_interval >
8. < min_warning >
9. < max_warning >
10. < min_critical >
11. < max_critical >
12. < str_critical >
13. < history_data >
14. < configuration_data >
15. < disabled_types_event >
16. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be: < macro name >:< macro value >.
17. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

.../include/api.php?op=set&op2=update_data_module_policy&id=1&other=10|data%20module%20updated%20by%20Api|2|0|0|50.00|10|20|180||21|35||1|module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates an SNMP module.

Call syntax:

• op=set (required).
• op2=update_snmp_module (required).
• id=< module_id > (required). It should be a module id.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < ip_target >
13. < module_port >
14. < snmp_version >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < snmp3_priv_method [AES|DES] >
24. < snmp3_priv_pass >
25. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
26. < snmp3_auth_method [MD5|SHA] >
27. < snmp3_auth_user >
28. < snmp3_auth_pass >
29. < disabled_types_event >
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical>
34. < policy_linked >
35. < ff_type >
36. < ignore_unknown > Accepts values 0 and 1.
37. < number_of_intervals_in_warning > Allows state scaling by specifying the maximum number of consecutive intervals in which the module remains in warning state. If this value is exceeded, the module will escalate to critical status.

Example (see call syntax):

(SNMP v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw):

…/include/api.php?op=set&op2=update_snmp_module&id=33432&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module&20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Another example with state scaling and SNMP v1:

…/include/api.php?op=set&op2=update_snmp_module&id=137&other=|0|6|20|25||26|30||15|1|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Another example with state scaling and SNMP v3:

…/include/api.php?op=set&op2=update_snmp_module&id=138&other=|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw|||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It applies the policy, once it has gone through id, in one or several agents.

Call syntax:

• op=set (required)
• op2=apply_policy (required)
• id=<id_policy> (required)
• id2=<id_agent> (optional). Id or name of the agent as indicated in the other parameter. If it is empty, the policy will be applied to all its agents.
• other=<serialized parameters>
  • <name_agent (Integer)>. It indicates whether the agent will be sent by Id (0), by name (1) or by alias (2).
  • <server_id> (required when using Command Center (Metaconsole)). Id of the server in which the policy will be applied.

Examples

http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It applies all policies within Pandora FMS.

Call syntax:

• op=set (required)
• op2=apply_all_policies (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora

It adds a network module in the policy after it has gone through id in the parameter.

Call syntax:

• op=set (required).
• op2=add_network_module_policy (required).
• id=< id_policy > (required). It should be a policy Id.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < id_module_type >
3. < description >
4. < id_module_group >
5. < min_value >
6. < max_value >
7. < post_process >
8. < module_interval >
9. < min_warning >
10. < max_warning >
11. < str_warning >
12. < min_critical >
13. < max_critical >
14. < str_critical >
15. < history_data >
16. < ff_threshold >
17. < disabled >
18. < module_port >
19. < snmp_community >
20. < snmp_oid >
21. < custom_id >
22. < enable_unknown_events >
23. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
24. < each_ff >
25. < ff_threshold_normal >
26. < ff_threshold_warning >
27. < ff_threshold_critical >
28. < ff_type >
29. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

…/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It adds a plugin module in the policy that has gone through id in the parameter.

Call syntax:

• op=set (required).
• op2=add_plugin_module_policy (required).
• id=< id_policy > (required). It should be a policy Id.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < id_module_type >
3. < description >
4. < id_module_group >
5. < min_value >
6. < max_value >
7. < post_process >
8. < module_interval >
9. < min_warning >
10. < max_warning >
11. < str_warning >
12. < min_critical >
13. < max_critical >
14. < str_critical >
15. < history_data >
16. < ff_threshold >
17. < disabled >
18. < module_port >
19. < snmp_community >
20. < snmp_oid >
21. < custom_id >
22. < enable_unknown_events >
23. < module_macros > It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”. See example at end of this section.
24. < each_ff >
25. < ff_threshold_normal >
26. < ff_threshold_warning >
27. < ff_threshold_critical >
28. < ff_type >
29. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

…/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

The content should be an object made up by objects with the following properties:

• “macro”: Macro name. It should be _field1_, _field2_, …, _fieldN_.
• “desc”: Descriptive macro name.
• “help”: Macro description.
• “value”: Macro value.

It should be a base64 encoded JSON document.

Example

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

It adds a local module in the policy which has gone through id in the parameter.

Call syntax:

• op=set (required)
• op2=add_data_module_policy (required)
• id=<id_policy> (required). It should be a policy Id.
• other=<serialized parameters> (required). They are module configuration and data, serialized in the following order:
  • <name_module>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <configuration_data>. This is the definition block of the agent that will be entered in the config file of the policy agent.
  • <enable_unknown_events> (only in version 5 or later)
  • <module_macros> (only in version 5). It should be a base64 encoded JSON document made up by an object with one property for each macro. The format of the JSON properties should be “<macro name>”: “<macro value>”.
  • <ff_threshold> (only in version 5.1 )
  • <each_ff> (only in version 5.1)
  • <ff_threshold_normal> (only in version 5.1)
  • <ff_threshold_warning> (only in version 5.1)
  • <ff_threshold_critical> (only in version 5.1)
  • <ff_timeout> (only in version 5.1)
  • <ff_type> (only in version 734)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora

Updates a plugin module in the policy passed by identifier in the parameter.

Call syntax:

• op=set (required).
• op2=update_plugin_module_policy (required).
• id= < id_policy > (required) must be a policy identifier.
• other= < serialized parameters > (required) are the module configuration and data, serialized in the following order:

1. < id_policy_module >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < module_port >
13. < snmp_community >
14. < snmp_oid >
15. < module_interval >
16. < post_process >
17. < min_value >
18. < max_value >
19. < custom_id >
20. < description >
21. < id_plugin >
22. < plugin_user >
23. < plugin_pass >
24. < plugin_parameter >
25. < disabled_types_event >
26. < macros > Values must be in base 64 encoded JSON format. See example at the end of this section.
27. < module_macros > The values must be in base 64 encoded JSON format. The format of the data in the JSON document must be “< macro name >”: “< macro value >”.
28. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

…/include/api.php?op=set&op2=update_plugin_module_policy&id=1&other=23|0|1|0|0||0|0||15|0|166|||180|150.00|0|0|0|plugin%20module%20updated%20from%20api|2|example_user|pass|-p%20min&other_mode=url_encode_separator_|

The content of the JSON document must be an object composed of several objects with the following properties:

• “macro”: Name of the macro. Must be _field1_, _field2_, …, _fieldN_.
• “desc”: Descriptive name of the macro.
• “help”: Macro description.
• “value”: Macro value.

It adds a SNMP module in the policy which has gone through id in the parameter.

Call syntax:

• op=set (required).
• op2=add_snmp_module_policy (required).
• id=< id_policy > (required). It should be a policy Id.
• other=< serialized parameters > (required). They are module configuration and data, serialized in the following order:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < module_port >
14. < snmp_version >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < snmp3_priv_method [AES|DES] >
24. < snmp3_priv_pass >
25. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
26. < snmp3_auth_method [MD5|SHA] >
27. < snmp3_auth_user >
28. < snmp3_auth_pass >
29. < enable_unknown_events >
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical >
34. < ff_type >
35. < ignore_unknown > Accepts values 0 and 1.

Example (see call syntax):

…/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP module modified by API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It adds an agent to a policy using the agent ID

Call syntax:

• op=set (required)
• op2=add_agent_policy_by_id (mandatory)
• id=<id_policy> (required). It must be a policy Id.
• other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order:
  • <id_agent>
  • <id_node> (required when using the Command Center (Metaconsole)). ID of the node the agent you wish to add to the policy belongs to.

Examples

• Node:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

• Command Center (Metaconsole):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It adds an agent to a policy using the agent name.

Call syntax:

• op=set (required)
• op2=add_agent_policy_by_name (required)
• id=<id_policy> (required). It must be a policy Id.
• other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order:
  • <agent_name>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It deletes an agent from a policy using the agent ID.

Call syntax:

• op=set (required)
• op2=remove_agent_from_policy_by_id (required)
• id=<id_política> (required). It must be a policy Id.
• other=<serialized parameters> (required). These are the agent’s configuration and data, serialized in the following order:
  • <id_agent>
  • <id_node> (required when using the Command Center (Metaconsole)). ID of the node the agent you wish to remove from the policy belongs to.

Examples

• Node:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

• Command Center (Metaconsole):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It deletes an agent from a policy using the agent name.

Call syntax:

• op=set (required)
• op2=remove_agent_from_policy_by_name (required)
• id=<id_policy> (required). It must be a policy Id.
• other=<serialized parameters> (required). These are the agent’s configuration and data, serialized in the following order:
  • <agent_name>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

It creates a new network component.

Call syntax:

• op=set (required)
• op2=new_network_component (required)
• id=<network_component_name> (required). It should be the network component name.
• other=<serialized parameters> (required). They are agent configuration and data of the network component, serialized in the following order:
  • <network_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <snmp_community>
  • <id_module_group>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <network_component_group>
  • <enable_unknown_events> (only in version 5)
  • <each_ff> (only in version 5.1)
  • <ff_threshold_normal> (only in version 5.1)
  • <ff_threshold_warning> (only in version 5.1)
  • <ff_threshold_critical> (only in version 5.1)
  • <ff_type> (only in version 734)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates a new plugin component.

Call syntax:

• op=set (required)
• op2=new_plugin_component (required)
• id=<plugin_component_name> (required). It should be the plugin component name.
• other=<serialized parameters> (required). They are agent configuration and data of the plugin component, serialized in the following order:
  • <plugin_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <module_port>
  • <id_module_group>
  • <id_plugin>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <plugin_component_group>
  • <enable_unknown_events> (only in version 5)
  • <each_ff> (only in version 5.1)
  • <ff_threshold_normal> (only in version 5.1)
  • <ff_threshold_warning> (only in version 5.1)
  • <ff_threshold_critical> (only in version 5.1)
  • <ff_type> (only in version 734)

Examples

http://127.0.0.1/pandora_console/include/api.php?op|http://127.0.0.1/pandora_console/include/api.php?op=set&op2= new_plugin_component&id=example_plugin_component_name&other =2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass =1234&user=admin&pass=pandora

It creates a new SNMP component.

Call syntax:

• op=set (required)
• op2=new_snmp_component (required)
• id=<snmp_component_name> (required). It should be the SNMP component name.
• other=<serialized parameters> (required). These are the configuration and data of the snmp component, serialized in the following order:
  • <snmp_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <id_module_group>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <snmp_version>
  • <snmp_oid>
  • <snmp_community>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <module_port>
  • <snmp3_privacy_method>
  • <snmp3_privacy_pass>
  • <snmp3_auth_method>
  • <snmp3_security_level>
  • <snmp_component_group>
  • <enable_unknown_events> (only in version 5)
  • <each_ff> (only in version 5.1)
  • <ff_threshold_normal> (only in version 5.1)
  • <ff_threshold_warning> (only in version 5.1)
  • <ff_threshold_critical> (only in version 5.1)
  • <ff_type> (only in version 734)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates a new local component.

Call syntax:

• op=set (required)
• op2=new_local_component (required)
• id=<local_component_name> (required). It should be a local component name.
• other=<serialized parameters> (required). They are configuration and data of the local component, serialized in the following order:
  • <description>
  • <id_os>
  • <local_component_group>
  • <configuration_data>. This is the module configuration block.
  • <enable_unknown_events> (only in version 5)
  • <ff_threshold> (only in version 5.1)
  • <each_ff> (only in version 5.1)
  • <ff_threshold_normal> (only in version 5.1)
  • <ff_threshold_warning> (only in version 5.1)
  • <ff_threshold_critical> (only in version 5.1)
  • <ff_timeout> (only in version 5.1)
  • <ff_type> (only in version 734)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora

It creates an alert template.

Call Syntax:

• op=set (required)
• op2=create_alert_template (required)
• id=<template_name> (required). It is the template name.
• other=<serialized parameters> (required). They are template configuration and data, serialized in the following order:
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always|not_normal]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>
  • <special_day>
  • <min_alerts_reset_counter>
  • <field1_recovery>
  • <field4>
  • <field5>
  • <field6>
  • <field7>
  • <field8>
  • <field9>
  • <field10>
  • <field11>
  • <field12>
  • <field13>
  • <field14>
  • <field15>
  • <field4_recovery>
  • <field5_recovery>
  • <field6_recovery>
  • <field7_recovery>
  • <field8_recovery>
  • <field9_recovery>
  • <field10_recovery>
  • <field11_recovery>
  • <field12_recovery>
  • <field13_recovery>
  • <field14_recovery>
  • <field15_recovery>

Examples

Example 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=example&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 2 (condition: value is not between 5 and 10, max_value: 10.00, min_value: 5.00, time_from: 00:00:00, time_to: 15:00:00, priority: CRITICAL, group: Servers):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|1||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates the template alert.

Call Syntax:

• op=set (required)
• op2=update_alert_template (required)
• id=<id_template> (required). It should be a template id.
• other=<serialized parameters> (required). They are template configuration and data, serialized in the following order:
  • <template_name>
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>
  • <special_day>
  • <min_alerts_reset_counter>
  • <field1_recovery>
  • <field4>
  • <field5>
  • <field6>
  • <field7>
  • <field8>
  • <field9>
  • <field10>
  • <field11>
  • <field12>
  • <field13>
  • <field14>
  • <field15>
  • <field4_recovery>
  • <field5_recovery>
  • <field6_recovery>
  • <field7_recovery>
  • <field8_recovery>
  • <field9_recovery>
  • <field10_recovery>
  • <field11_recovery>
  • <field12_recovery>
  • <field13_recovery>
  • <field14_recovery>
  • <field15_recovery>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=18&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%202|field%20recovery%20example%203|1|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It deletes a alert template and deletes all the alerts it defines.

Call Syntax:

• op=set (required)
• op2=delete_alert_template (required)
• id=<id_template> (required). It should be a template id.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38&apipass=1234&user=admin&pass=pandora

It deletes a module template.

Call Syntax:

• op=set (required)
• op2=delete_module_template (required)
• id=<id_alert_template_module> (required). It should be an alert_template_module id.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38&apipass=1234&user=admin&pass=pandora

It deletes a module template.

Call Syntax:

• op=set (required)
• op2=delete_module_template_by_names (required)
• id=<agent name> (required)
• id2=<alert template name> (required)
• other=<serialized parameter> (required). They are the following in this order:
  • <module name> (required)
  • <use_agent_alias> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_|

It stops a downtime.

Call Syntax:

• op=set (required)
• op2=stop_downtime (required)
• id=<id_downtime> (required). It should be an id downtime.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1&apipass=1234&user=admin&pass=pandora

It creates a new user in Pandora FMS.

Call Syntax:

• op=set (required).
• op2=new_user (required).
• id=< identification_user > (required).
• other=< serialized_parameters > (all and each one are required) they are user configuration and data, serialized in the following order:
  1. < full_name > (replace spaces with %20 )
  2. < first_name >
  3. < surname >
  4. < middle_name >
  5. < password >
  6. < e_mail >
  7. < phone_number >
  8. < language >
  9. < comments >
  10. < time_autorefresh >
  11. < default_event_filter >
  12. < console_section >
  13. < session_time >

Example (see call syntax):

.../include/api.php?op=set&op2=new_user&id=id_nu&other=John%20J.%20Doe|John|Doe|Jay|1234|johndoe@example.com|5555555|en||30|||-1|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates a user selected by the id in the id parameter.

Call Syntax:

• op=set (required)
• op2=update_user (required)
• id=<user_name> (required). It should be a user name.
• other=<serialized parameters> (required). They are module configuration and data, serialized in the following order:
  • <fullname>
  • <firstname>
  • <lastname>
  • <middlename>
  • <password>
  • <email>
  • <phone>
  • <languages>
  • <comments>
  • <is_admin>
  • <block_size>
  • <flash_chart>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Deletes a user by means of its identifier.

Call syntax:

• op=set (required).
• op2=delete_user (required).
• id=< id_user > (required) the identifier of the user to delete (User ID).

Example ( see call syntax):

../include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora

It deletes user permissions.

Call syntax:

• op=set(requiered)
• Op2=delete_user_permission(requiered)
• Return_type=csv|json(requiered)
• Other=id profile(requiered)

Example

It deletes user permissions. It can return Json or CSV, this return is remarked through the URL.

http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It adds permissions to a user group.

Call syntax:

• Op=set(requiered)
• Op2=add_permission_user_to_group(requiered)
• Return_type=csv|json(requiered)
• Other=user id(requiered)|group_id(requiered)|profile id(requiered)|No hierarchy(Optional)| profile id(Optional)

Examples

It can return Json or CSV, this return is remarked through the URL.

http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1|20&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It enables a disabled user.

Call syntax:

• op=set (required)
• op2=enable_disable_user (required)
• id=<user_name> (required). It should be a username.

Examples

Example 1 (Disable user 'example_name')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 2 (Enable user 'example_name')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It syncronizes Command Center (Metaconsole) users to the node

Call syntax:

• op=set (required)
• op2=meta_synch_user (required)
• other=<serialized parameters> (opcional):
  • <user_name_1,user_name_2,user_name_3..> (Usernames separated by comma and without spaces at the beginning or the end, required)
  • <server_name> (required)
  • <profile_mode(1-0)> (optional)
  • <group_name> (optional)
  • <profile_1,profile_2,profile_3> (Profiles separated by comma and without spaces at the beginning or at the end, optional)
  • <create_groups(1-0)> (optional)

Example

http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|

It creates a group.

Call syntax:

• op=set (required)
• op2=create_group (required)
• id=<group_name> (required). It should be a group name.
• other=<serialized_parameters> (required). They are the following in this order:
  • <icon name>
  • <parent group id> (optional)
  • <description> (optional)
  • <propagate acl> (optional)
  • <disable alerts> (optional)
  • <custom id> (optional)
  • <contact info> (optional)
  • <other info> (optional)
  • <Maximum number of agents in the group> (required, zero means no limit)
  • <Create Agent group with password> (optional)

Examples

Example 1 (with parent group: Servers)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 2 (without parent group)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 3 (create a group of agents with password 1234, and with a limit of 3 Agents in the group)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|2|||||||3|1234&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It updates a group with past data as parameters.

Call syntax:

• op=set (required)
• op2=update_group (required)
• id=<group_id> (required). It should be a group id
• other=<serialized_parameters> (required). They are the following in this order:
  • <group name>
  • <icon name>
  • <parent group id>
  • <description>
  • <propagate acl>
  • <disable alerts>
  • <custom id>
  • <contact info>
  • <other info>

Example

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It deletes a group.

Call syntax:

• op=set (required)
• op2=delete_group (required)
• id=<group_id> (required) it should be a group id

Example

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora

It adds a profile into user.

Call syntax:

• op=set (required)
• op2=add_user_profile (required)
• id=<user_name> (required). It should be a user name.
• other=<serialized parameters> (required). They are group and profile configuration and data, serialized in the following order:
  • <group>
  • <profile>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It deletes a profile from a user.

Call syntax:

• op=set (required)
• op2=delete_user_profile (required)
• id=<user_name> (required). It should be a user name.
• other=<serialized parameters> (required). They are the group configuration, data and profile, serialized in the following order:
  • <group>
  • <profile>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates a new incident.

Call syntax:

• op=set (required)
• op2=new_incident (required)
• other=<serialized parameters> (required). They are incident configuration and data, serialized in the following order:
  • <title>
  • <description>
  • <origin>
  • <priority>
  • <status>
  • <group>

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It adds a note within an incident.

Call syntax:

• op=set (required)
• op2=new_note_incident (required)
• id=<id_incident> (required). It is the incident id.
• id2=<user_name> (required). Username.
• other=<note> (required). It is the note codified in url encode.

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia&apipass=1234&user=admin&pass=pandora

It validates all alerts.

Call syntax:

• op=set (required)
• op2=validate_all_alerts (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts&apipass=1234&user=admin&pass=pandora

It validates the alerts created from a policy.

Call syntax:

• op=set (required)
• op2=validate_all_policy_alerts (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts&apipass=1234&user=admin&pass=pandora

It validates all events that pass the past filter as parameters.

Call syntax:

• op=set (required)
• op2=event_validate_filter (required)
• other_mode=url_encode_separator_|(optional)
• other=<serialized_parameters> (optional). They are the following in this order:
  • <separator>
  • <criticity> From 0 to 4
  • <agent name>
  • <module name>
  • <alert template name>
  • <user>
  • < numeric interval minimum level> en unix timestamp
  • < numeric interval maximum level> en unix timestamp
  • <use_agent_name> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora

It is similar to previous call.

Call syntax:

• op=set (required))
• op2=event_validate_filter_pro (required)
• other_mode=url_encode_separator_| (optional)
• other=<serialized parameters> (optional). They are the following in this order:
  • <separator>
  • <criticity> From 0 to 4
  • <id agent>
  • <id module>
  • <id agent module alert>
  • <user>
  • <numeric interval minimum level> in unix timestamp
  • <numeric interval maximum level> in unix timestamp

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora

Validates an event given its id.

Call syntax:

• op=set (required)
• op2=validate_event_by_id (required)
• id=<event_id> (required) event id.

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=validate_event_by_id&id=23&apipass=1234&user=admin&pass=pandora

It applies a new alert from a template and module which has gone through id agent and module name.

Call syntax:

• op=set (ob)
• op2=new_alert_template (required)
• id=<agent name> (required)
• id2=<alert template name> (required)
• other_mode=url_encode_separator_| (optional)
• other=<serialized parameter> (required). They are the following in this order:
  • <module name> (required)
  • <use_agent_alias> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree&apipass=1234&user=admin&pass=pandora

It adds actions within an alert.

Call syntax:

• op=set (required)
• op2=alert_actions (required)
• id=<agent name> (required)
• id2=<alert template name> (required)
• other_mode=url_encode_separator_| (required)
• other=<serialized parameters> (required). They are the following in this order:
  • <module name> (required)
  • <action name> (required)
  • <fires min > (optional)
  • <fires max > (optional)
  • <use_agent_alias> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test&apipass=1234&user=admin&pass=pandora

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3&apipass=1234&user=admin&pass=pandora

It adds commands within an alert.

Call syntax:

• op=set (required)
• op2=alert_commands (required)
• id=<name of the command> (required)
• other_mode=url_encode_separator_| (optional)
• other=<serialized parameters> (required). They are the following in this order:
  • <command> (required)
  • <id_group> (required)
  • <description > (required)
  • <internal > (optional)
  • <field_description_1><field_value_1><field_description_2><field_value_2>…<field_description_n><field_value_n>

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It creates a new module.

Call Syntax:

• op=set (required)
• op2=new_module (required)
• id=<agent_name> (required)
• id2=<new module name> (required)
• other_mode=url_encode_separator_| (optional)
• other=<serialized parameters> (required). They are the following in this order:
  • <network module kind > (required)
  • <action name> (required)
  • <ip o url > (required)
  • <port > (optional)
  • <description > (optional)
  • <min > (optional)
  • <max > (optional)
  • <post process > (optional)
  • <module interval > (optional)
  • <min warning > (optional)
  • <max warning > (optional)
  • <min critical > (optional)
  • <max critical > (optional)
  • <history data > (optional)
  • <enable_unknown_events> (only in version 5)
  • <use_agent_alias> (Values 0 and 1 supported)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga&apipass=1234&user=admin&pass=pandora

It deletes a module.

Call syntax:

• op=set (required).
• op2=delete_module (obligatorio)
• id=< agent name > (obligatorio).
• id2=< module name > (obligatorio).

Example (see call syntax):

.../include/api.php?op=set&op2=delete_module&id=example&id2=example2&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_|

simulate parameter

If you want to confirm if the agent exists and its module also exists, before executing the final deletion you can use the simulate parameter. If your test call is incorrect the PFMS API 1.0 will return the following message: Parameter error..

Example (see call syntax):

.../include/api.php?op=set&op2=delete_module&id=agent_name_example&id2=module_name_example&other=simulate&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It enables an agent alert.

Call syntax

• op=set (required)
• op2=enable_alert
• id=<Agent name> (required)
• id2=<Module name> (required)
• other:Alert template name (p.e: Warning event) (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora

It enables agent alert by alias.

Call syntax:

• op=set (required)
• op2=enable_alert_alias
• id=<Agent alias> (required)
• id2=<Module name> (required)
• other:Alert template name (p.e: Warning event) (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

It disables an agent alert.

Call syntax:

• op=set (required)
• op2=disable_alert
• id=<Agent name> (required)
• id2=<Module name> (required)
• other:Alert template name (p.e: Warning event) (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora

It disables an agent alert.

Call syntax:

• op=set (required)
• op2=disable_alert_alias
• id=<Agent alias> (required)
• id2=<Module name> (required)
• other:Alert template name (p.e: Warning event) (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=nova&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

Same as enable_alert api call.

Call syntax:

• op=set (required)
• op2=enable_module_alerts
• id=<Name of the agent> (required)
• id2=<Name of the module> (required)
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora

Same as api disable_alert.

Call syntax:

• op=set (required)
• op2=disable_module_alerts
• id=<Name of the agent> (required)
• id2=<Name of the module> (required)
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora

It enables the module.

Call syntax

• op=set (required)
• op2=enable_module
• id=<Agent name> (required)
• id2=<Module name> (required)
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora

It disables the module.

Call syntax:

• op=set (required)
• op2=disable_module
• id=<Agent name> (required)
• id2=<Module name> (required)
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora

It creates a new network module from a component.

Call syntax:

• op=set (required)
• op2=create_network_module_from_component (required)
• id=<Agent name> (required)
• id2=<Component name> (required)
• other (optional)=<use_agent_alias> (Values 0 and 1 supported)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=garfio&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora

It adds a module value. This function generates an XML with the data that will be sent to the server, which will be the one to update the database.

This API call just controls the XML file generation, displaying in a message the status of that process.

Call syntax:

• op=set (required)
• op2=module_data (required)
• id=<id module agent> (required)
• other:module data and timestamp serialized.
  • dato: data which must belong to any Pandora FMS data type.
  • tiempo: it could be a specified timestamp of the string now.

Example

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora

It creates a new module group.

Call syntax:

• op=set (required)
• op2=new_module_group (required)
• id=<name of the module group> (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora

It syncronizes a module group from the Command Center (Metaconsole).

Call syntax:

• op=set (required)
• op2=module_group_synch (required)
• other=<serialized parameters> (required). In this case, the name of the server(s)that are required to sync with the meta.
  • <server_name_1><server_name_2>…<server_name_n> (required)

Examples

http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

It adds the configuration to a local module.

Call syntax:

• op=set (required)
• op2=add_module_in_conf (required)
• id=<agent id> (required)
• id2=<module name> (required)
• other:The module data that will be placed in the conf file encoded in base64 (required) (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

It will return '0' when it is successful, '-1' when there is an error and '-2' if it already exists.

It deletes a local module configuration.

Call syntax:

• op=set (required)
• op2=add_module_in_conf (required)
• id=<agent id> (required)
• id2=<module name> (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_nameInsert non-formatted text here

It will return '0' when it is successful or '-1' when there is an error

It updates a local module configuration.

Call syntax:

• op=set (required)
• op2=update_module_in_conf (required)
• id=<agent id> (required)
• id2=<module name> (required)
• other:The new module data that will be placed in the conf file encoded in base64 (required)

Examples

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

It will return '1' when there are no changes, '0' when it is successful, '-1' when there is an error and '-2' if does not exist.

It creates a new event in Pandora FMS.

Call syntax:

• op=set (required).
• op2=create_event (required).
• other=< serialized_parameters > (required), they are the configuration and event data, serialized in the following order:
  • < event_text > (required, string type).
  • < id_group > (required, string type).
  • < id_agent> (required, numeric type).
  • < status > 0 New, 1 Validated, 2 In process.
  • < id_user >
  • < event_type > Any of the following values:
    • unknown
    • alert_fired
    • alert_recovered
    • alert_ceased
    • alert_manual_validation
    • system
    • error
    • new_agent
    • configuration_change
    • going_unknown
    • going_down_critical
    • going_down_warning
    • going_up_normal
  • < severity > Any of the following values:
    • 0 Maintenance.
    • 1 Informative.
    • 2 Normal.
    • 3 Warning.
    • 4 Critical.
    • 5 Minor.
    • 6 Major.
  • < id_agent_module > (numeric type).
  • < id_alert_am> ( ID Alert Module linked to event, numeric type).
  • < critical_instructions > (string type).
  • < warning_instructions > (string type).
  • < unknown_instructions > (string type).
  • < comment > (string type).
  • < owner_user_name > (string type).
  • < event_source > (string type).
  • < tags > (string type).
  • < custom_data> Custom data should be a base64 encoded JSON document.
  • < server_id > (only for Command Center (Metaconsole)) The id of the child node.
  • <id_extra> (alphanumeric type, see , véase Keep in process status for new events with extra ID).

Example ( see call syntax):

The event to be created has the following custom JSON data:

{"Answer to the Ultimate Question of Life, the Universe, and Everything": 42}

The above is encoded in base64 and inserted in the call:

../include/api.php?op=set&op2=create_event&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora&other=Event_name|0|1|0|admin|alert_fired|4|1|||||comment|admin||tags|eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=||12

It adds an event comment.

Call syntax:

• op=set (required).
• op2=add_event_comment (required).
• id=< id_event > (required, numeric type).
• other=< serialized_parameters > (required) are the comment to be added and, if used in Command Center (Metaconsole), the numerical identifier of the node, data serialized as follows:
  • < comment > (required, string type).
  • < separator > (optional, for Command Center -Metaconsole- use).
  • < id_node > (optional, for Command Center -Metaconsole- use).
• url_encode_separator_< separator >:See call syntax.

Examples (see call syntax)

• Node (event id is 7 and comment is comment):

../include/api.php?op=set&op2=add_event_comment&id=7&other=comment&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

• Command Center (Metaconsole) (NG 766 and later, the event identifier is 1, the comment is comment and the node identifier is 3):

../include/api.php?op=set&op2=add_event_comment&id=1&other=comment|3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Updates events through API.

Call syntax:

• op=set (required)
• op2=event (required)
• id=event_id (required)
• other=<serialized_parameters> (required). Event fields to be updated, formatted as field,value and separated by the chosen url_encode_separator (e.g. |).

= Available fields =

• estado: Numeric identifier of the event status. It can be:
  • 0 (New)
  • 1 (Validated)
  • 2 (In process)
• evento: Event name.
• event_type: Event type. It can be:
  • going_unknown
  • unknown
  • alert_fired
  • alert_recovered
  • alert_ceased
  • alert_manual_validation
  • recon_host_detected
  • system
  • error
  • new_agent
  • going_up_warning
  • going_up_critical
  • going_down_warning
  • going_down_normal
  • going_down_critical
  • going_up_normal
  • configuration_change
• criticity: Numeric identifier of the event's criticity. It can be:
  • 0 (Maintenance)
  • 1 (Informational)
  • 2 (Normal)
  • 3 (Minor)
  • 4 (Warning)
  • 5 (Major)
  • 6 (Critical)
  • 20 (Warning o Critical)
  • 21 (Distinto a Normal)
  • 34 (Critical o normal)
• tags: Tags associated to the event.
• source: Source of the event's data.
• id_extra: When using this feature, older events with the same Extra ID as the new one will be automatically validated.
• critical_instructions: Instructions for operators on the actions to be done when a module goes to Critical status. Only shown in the event if module is on Critical status.
• warning_instructions: Instructions for operators on the actions to be done when a module goes to Warning status. Only shown in the event if module is on Warning status.
• unknown_instructions: Instructions for operators on the actions to be done when a module goes to Unknown status. Only shown in the event if module is on Unknown status.
• owner_user: User assigned to the event.
• custom_data: It allows to add custom information to the event. It must be formated as a base64 encoded json (e.g.