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.
A call to the API is as simple as this:
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 callsop2
(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_|
You can use any separator, in this documentation the |
character (%7C
percent-encoded) is used preferentially. See also how works the API checker.
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.The API authenticates access via API source and/or password and/or 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.In API calls, passwords are uncoded. Be careful and use SSL connections to avoid sniffers from third party. The API allows POST petitions to encrypt them when using SSL/HTTPS.
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
.
Pandora FMS has installed, by default, a user called internal_API
which has neither a password nor a superadmin. For this user, as well as for the others that are created, the appropriate profiles should be established for each one of the commands and operations described here.
.../include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
Access conditions:
*
).1234
.admin
exists and is a superadmin user, and its password is pandora
.Menu Management → Admin tools → API checker.
Version 768 or later: You can authenticate with API Token by sending in the HTTP headers a bearer token generated by each user and for their own private and particular use. See “Edit my user” for more details.
It is implemented thanks to three elements:
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.
Version 768 or later: You can authenticate with API Token by sending in the HTTP headers a bearer token generated by each user and for their own private and particular use. See “Edit my user” for more details.
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.
Version 768 or later: If a warning icon appears next to the API Token, configure the php.conf
file.
The following examples use the command line program cURL, version 7.68 .
curl -V
.curl -h
.-k
and -H
parameters are used to accept connections with self-signed certificates for HTTPS and send header information, respectively.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 ""
-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.
http://127.0.0.1/pandora_console/include/api.php?info=version
A return sample could be: Pandora FMS v7.0NG.768 - PC230120 MR60
It returns the required data.
It checks the connection to the API and returns the version of Pandora FMS Console.
This feature is in Command Center (Metaconsole).
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.
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.
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:unknown
, warning
, critical
, no_modules
.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:
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:
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:
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:
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
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.
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:It is absolutely essential to use
other_mode=url_encode_separator_< separator >
with this parameter!
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:
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:
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:
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:
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:
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:
yes
of the csv
.|
could be specified in other_mode
):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:
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:
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.
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:0
to number 6
:0:Maintenance
1:Informational
2:Normal
3:Warning
4:Critical
5:Minor
6:Major
1
to filter events generated by alerts.0
to filter non-validated events, 1
for validated events.0
).total
: it simply returns the total number of events, for example in JSON format delivers: {“type”:“json”,“data”:{“count”:990}}
.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”}]}
.get tags
). JSON format required, for example: [“2”,“5”]
(see call syntax).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:
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:
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:
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.
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:
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.
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:
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:
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:
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:
Examples
http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora
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:
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:
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.
op=get
(required).op2=alert_actions
(required).return_type=
< list_format > choice csv
or json
(required).other=
< serialized parameter > (optionals):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
This feature is in Command Center (Metaconsole).
List of node alert actions from Command Center (Metaconsole).
Call syntax:
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:
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.
This feature is in Command Center (Metaconsole).
Call syntax:
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)
Call syntax:
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:
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:
It translates the name of the custom field into the ID it has in the data base.
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:
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:
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:
csv
or csv_head
.yes
of the csv
.|
could be specified in other_mode
):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:
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:
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:
From version NG 752 onwards, more parameters are available, please pay attention to the mandatory fields and their separators |
or its Escape character %7C
.
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:
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:
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:
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:
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:
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:
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
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
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
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
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
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
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
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:
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:
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:
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:
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:
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:
Call syntax:
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:
Call syntax:
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:
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:
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:
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:
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:
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
It returns the list of Pandora FMS users.
Call syntax:
Example
This example will return all users in csv format.
http://localhost/pandora_console/include/api.php?op=get&op2=users&return_type=csv&apipass=1234&user=admin&pass=pandora&other_mode=url_encode_separator_&
This feature is in Command Center (Metaconsole).
It lists all Pandora FMS users.
Call syntax:
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
This feature is in Command Center (Metaconsole).
It lists user data.
Call syntax:
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:
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.
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:
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:
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:
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
This feature is in Command Center (Metaconsole).
It obtains user groups through filtering.
Call syntax:
Example
It can return Json or CSV. This return is remarked through the URL.
Be careful, one of the two variables (group id or Enabled) may be empty, but at least one of them should be filled out.
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:
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:
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:
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:
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:
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:
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.
This feature is in Command Center (Metaconsole).
Call syntax:
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:
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.
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: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
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.
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: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:
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:
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:
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:
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.
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:0
and 1
.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.
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:0
and 1
.0
and 1
.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.
With this call, you may add database module data but the configuration file of the agents associated to the module cannot be modified.
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:0
and 1
supported.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.
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:0
and 1
.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.
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: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.
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:0
and 1
.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:
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
With this call, a database module data can be added but the configuration file of the agents associated to the module cannot be modified.
It updates the local module.
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
for disable, 0
for no changes.0
, module data will not be saved at tagente_datos
, only tagent_estado
will be updated.{“going_unknown”:1}
.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.
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:< macro name >:< macro value >
.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.
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:0
and 1
.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:
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:
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.
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: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.
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: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:
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:
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.
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: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:
It adds a SNMP module in the policy which has gone through id in the parameter.
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: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:
Examples
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
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:
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:
Examples
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
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:
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:
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:
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 === set new_snmp_component === 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** <code> 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:
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:
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:
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:
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:
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:
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:
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.
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:%20
)If you lack any of the above thirteen fields simply type the separator (see call syntax) but in any case you must always place 13 separators.
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:
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.
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
This feature is in Command Center (Metaconsole).
It deletes user permissions.
Call syntax:
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
This feature is in Command Center (Metaconsole).
It adds permissions to a user group.
Call syntax:
Examples
It can return Json or CSV, this return is remarked through the URL.
Be careful, no_hierarchy may be empty. If that is the case, it takes value 0.
Be careful, permission id (id_up) in the table can be used if an existing permission must be modified.
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:
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
This feature is in Command Center (Metaconsole).
It syncronizes Command Center (Metaconsole) users to the node
Call syntax:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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.
This feature is in Command Center (Metaconsole).
Call syntax:
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.
This feature is in Command Center (Metaconsole).
Call syntax:
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:
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:
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:
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:
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:
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.
From version 768 onwards, if the module to be deleted (e.g. Host Alive ) is the parent of another module (“Cascading Protection Services” functionality), the child modules will also be deleted.
op=set
(required).op2=delete_module
(obligatorio)id=
< agent name > (obligatorio).d2=
< 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
It is absolutely essential to use
other_mode=url_encode_separator_< separator >
with this 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
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:
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:
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:
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:
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:
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
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:
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:
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:
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
The successful generation of the XML file doesn't guarantee that the data has been stored in the database.
It creates a new module group.
Call syntax:
Examples
http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora
This feature is in Command Center (Metaconsole).
It syncronizes a module group from the Command Center (Metaconsole).
Call syntax:
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:
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:
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:
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.
This feature also works in Command Center (Metaconsole).
op=set
(required).op2=create_event
(required).other=
< serialized_parameters > (required), they are the configuration and event data, serialized in the following order:0
New, 1
Validated, 2
In process.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
0
Maintenance.1
Informative.2
Normal.3
Warning.4
Critical.5
Minor.6
Major.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.
This feature also works in Command Center (Metaconsole).
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:url_encode_separator_
< separator >:See call syntax.Command Center (Metaconsole) usage:
true
.This node identifier can be obtained by accessing the Command Center:
Examples (see call syntax)
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
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.
This feature can be also used in the Command Center (Metaconsole).
Call syntax:
= Available fields =
{"field1":"value1","field2":"value2"}
). See example below.
Examples
http://192.168.80.190/pandora_console/include/api.php?op=set&op2=event&apipass=pandora&user=admin&pass=pandora&id=175&other_mode=url_encode_separator_|&other=estado,2|evento,Updated event|custom_data,eyJmaWVsZDEiOiJ2YWx1ZTEiLCJmaWVsZDIiOiJ2YWx1ZTIifQo=
http://192.168.80.35/pandora_console/include/api.php?op=set&op2=event&apipass=1234&user=admin&pass=pandora&id=315132&other_mode=url_encode_separator_|&other=estado,0|owner_user,operator|evento,Updated event
(>=5.0)
It creates a new netflow filter.
Call syntax:
Examples
http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|
It creates a new custom field for agents. Custom fields are useful in custom field macros for remote monitoring.
op=set
(required).op2=create_custom_field
(required).other=
< serialized parameters > (required) Parameters to configure the custom field.0
will not be displayed in the agent operation view, 1
will be displayed, (as long as it has a saved value).0
normal custom field, 1
its content will be hidden with asterisks in the Web Console.If the execution of the command is successful, it will return a numeric identifier corresponding to the custom field created.
Example (see call syntax) :
../include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
Make sure that the user used has the appropriate rights to create custom fields. In the example the credentials of a superadmin are used, if you use the default user internal_API
you will not be able to create such custom fields.
= 5.0
It creates a new tag.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
It enables a disabled agent.
Call syntax:
Examples
Example 1 (Disable agent 'example_id')
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
Example 2 (Enable agent 'example_id')
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
It adds a new GIS position within any agent.
Call syntax:
op=set
(required).op2=gis_agent_only_position
(required).id=
<index> (required). Agent index.other=
<serialized parameters> (required). Parameters to set the GIS using the url_encode_separator_
to differentiate them (use as decimal separator the dot .
):Example
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0
= 5.0
It adds a gis data agent.
Call syntax:
Ejemplo
http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc
It updates agent alert and module counting.
Call syntax:
All
.Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All
= 5.1
It adds a new special day.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0
= 5.1
It updates an already defined special day configuration.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0
= 5.1
It deletes a special day.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1
= 5.1
It connects PagerDuty notifications with Pandora FMS alerts. This call is set in the Webhook option in PagerDuty's service to validate Pandora FMS alerts which have been previously linked to Pager Duty when they were validated from PagerDuty.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert
= 6
It adds a tag into a user profile.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3
= 6
It adds a tag into Pandora FMS.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="a test"|http://www.artica.es|[email protected]|01189998819991197253
= 6
It adds a tag to a module.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2
= 6
It removes a tag from a module.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2
= 5.1
It adds new planned downtime.
Date format needs to be MM/DD/YYYY for this call to work properly.
Examples
Once:
http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|once|weekly|admin&other_mode=url_encode_separator_|
Periodically:
http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|
= 754
Edit a planned stop.
op=set
.op2=planned_downtimes_edit
.id=
planned shutdown identifier.other=
all parameters are optional:The date format must be YYYYY/MM/DD (year/month/day) for this call to work properly.
Example:
http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_edit&apipass=1234&user=admin&pass=pandora&id=2&other=testing2|test2| 2022/05/10|2022/06/12|19:03:03|19:55:00|0|0|0|0|0|0|0|0|1|31|quiet|once|weekly&other_mode=url_encode_separator_|
= 754
Add Agents to the planned stop.
op=set
.op2=planned_downtimes_agents
.id=
planned stop identifier.other=
identifier of each Agent separated by semicolons:Example:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_add_agents&apipass=1234&user=admin&pass=pandora&id=4&other=1;2;3&other_mode=url_encode_separator_|
= 754
Removes Agents (and the Modules of those agents) from the planned shutdown.
op=set
.op2=planned_downtimes_delete_agents
.id=
planned stop identifier.other=
identifier of each Agent separated by semicolons:Example:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_delete_agents&apipass=1234&user=admin&pass=pandora&id=4&other=1;2;3&other_mode=url_encode_separator_|
= 5.1 It adds new items of a planned downtime.
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|
=5.1
It deletes a planned downtime
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10
=5.1SP4
It adds a new synthetic module:
In arithmetic creations the first piece of data is Agent without operator: AgentName;NameModule or if you type in a value: <Operation;Value>. The rest of values follow this one: <AgentName;Operation;NameModule> or <Operation;Value> average: <AgentName;Operation;NameModule> or <Operation;Value>
arithmetic: ADD, SUB, MUL, DIV average: Only AVG
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=pepito&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|
= 7
It creates a new service.
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7
It modifies a service.
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7
It adds elements to a service.
The structure of the json should be as follows:
[ { "type": "agent", "id": 2, "description": "Test1", "weight_critical": 0, "weight_warning": 0, "weight_unknown": 0, "weight_ok": 0 }, { "type": "module", "id": 1, "description": "Test2", "weight_critical": 0, "weight_warning": 0, "weight_unknown": 0, "weight_ok": 0 }, { "type": "service", "id": 3, "description": "Test3", "weight_critical": 0, "weight_warning": 0, "weight_unknown": 0, "weight_ok": 0 } ]
In each type, the id field refers to different things:
- If it belongs to agent type, it is agent id
- If it belongs to module type, it is agent module id
- If it belongs to service type, it is the service id to be added.
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7
It adds license key to the Command Center (Metaconsole) and performs the synchronization with nodes.
Example
http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=LICENSEKEY&apipass=1234&user=admin&pass=pandora
= 7.21 ONLY METACONSOLE
It adds a selected agent to the agent migration queue.
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=nova|fringe|0&other_mode=url_encode_separator_|&return_type=string
= 7.0
It creates an agent cluster
It creates a monitoring cluster with agents and items to monitor different nodes.
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0
It adds an agent to a cluster.
The json structure should be:
[ { "id": 5, "id_agent": 2 }, { "id": 5, "id_agent": 3 } ]
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=WwogIHsKICAgICJpZCI6IDUsCiAgICAiaWRfYWdlbnQiOiAyCiAgfSwKICB7CiAgICAiaWQiOiA1LAogICAgImlkX2FnZW50IjogMwogIH0KXQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0
It adds an active/active item to a cluster
The json structure should be:
[ { "name": "Swap_Used", "id_cluster": 5, "type": "AA", "critical_limit": 80, "warning_limit": 60 }, { "name": "TCP_Connections", "id_cluster": 5, "type": "AA", "critical_limit": 80, "warning_limit": 60 } ]
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=WwogIHsKICAgICJuYW1lIjogIlN3YXBfVXNlZCIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9LAogIHsKICAgICJuYW1lIjogIlRDUF9Db25uZWN0aW9ucyIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9Cl0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0
It adds a passive/actve item to a cluster.
The json structure should be:
[ { "name": "DiskUsed_/proc/kcore", "id_cluster": 5, "type": "AP", "is_critical": 1 }, { "name": "DiskUsed_/proc/sched_debug", "id_cluster": 5, "type": "AP", "is_critical": 1 } ]
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=WwogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9LAogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL3NjaGVkX2RlYnVnIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9Cl0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0
It deletes a cluster.
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora
= 7.0
It unpairs an agent from a cluster
The json structure should be:
[ { "id": 5, "id_agent": 2 }, { "id": 5, "id_agent": 3 } ]
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agents&other=WwogIHsKICAgICJpZCI6IDUsCiAgICAiaWRfYWdlbnQiOiAyCiAgfSwKICB7CiAgICAiaWQiOiA1LAogICAgImlkX2FnZW50IjogMwogIH0KXQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0
It deletes an item from a cluster.
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora
= 7.0. 725
It creates a policy. Both the policy name, which cannot be repeated, and the id_group, which must exist in the database, are required.
Example
http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json
= 7.0. 725
It updates a policy. The policy name cannot be repeated and the id_group must exist in the database. It returns 0 (false) or the updated policy id (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=update_policy&apipass=1234&user=admin&pass=pandora&id=17&other=policy2|11|this%20description&other_mode=url_encode_separator_|&return_type=json
= 7.0. 725
It deletes a policy. It is required to enter the policy id, which must exist in order to delete it. It returns 0 (false) or 1 (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_policy&apipass=1234&user=admin&pass=pandora&id=10&return_type=json
= 7.0. 725
It adds a collection to a policy. It is necessary to enter the policy id and for such a policy to exist, as an id, name or short name of the collection you wish to add, which should exist too. Both fields are required. It returns 0 (false) or the id of the collection added to a policy (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=add_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=apache_plugin
= 7.0. 725
To mark a policy collection that is yet to be deleted, it is necessary:
It returns 0 (false) or 1 (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=remove_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=2&other=1.
= 7.0. 725
To add a plugin to a policy the following are necessary:
It returns 0 (false) or the plugin id that has been added to a policy (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=create_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2&id2=echo%201
= 7.0. 725
These are the requirements to remove a plugin from a policy:
It returns 0 (false) or 1 (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&id2=1&other=1
= 7.0. 725
To link an unlinked policy module it is necessary:
It returns 0 (false) or 1 (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=linking_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=28
= 7.0. 725
To create policy alert, these are necessary:
It returns 0 (false) or the id of the alert added in the policy (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|
= 7.0. 725
To update policy alerts, it is necessary:
It returns 0 (false) or the id of the updated alert in the policy (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=update_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=1|1&other_mode=url_encode_separator_|
= 7.0. 725
To remove an alert from a policy it is necessary:
It returns 0 (false) or 1 (true).
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=1
= 7.0. 725
To add an action to a policy alert it is necessary:
It returns 0 (false) or the id of the action added to the policy alert (true).
Example
http://172.16.0.2/pandora_console/include/api.php?op=set&op2=create_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4&other=5|2&other_mode=url_encode_separator_|
= 7.0. 725
To remove an action from a policy alert, it is necessary:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4
= 7.0. 725
To remove an agent from a policy, it is necessary:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=remove_agents_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2
= 7.0. 725
To add a policy group, it is necessary:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=add_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=12
= 7.0. 725
To remove an agent from a policy, it is necessary:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=remove_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2
= 7.0. 727
It creates a new operating system with the data as parameters.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_os&other=os_name%7Cos_description%7Cos_icon.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0. 727
It updates the operating system with data as parameters.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?id=107&op=set&op2=update_os&other=os_name_to_update%7Cos_description_to_update%7Cos_icon_to_update.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0. 728
It disables an agent and, if it has remote configuration, it makes it go into standby mode.
Call Syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?id=2&id2=1&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0. 728
It allows to validate traps.
Example
https://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0. 728
It allows to delete a trap:
Example
http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=delete_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
= 7.0NG. 728
This function allows to manage the access to a third application from records in the system audit log of Pandora FMS. It uses different parameters to process one of these registry actions in your application and avoids concurrent access by administrator users. Optionally, it can ban access to non-administrator users.
Call syntax:
The id of the user trying to access the application, this data is recorded and checked in the audit to filter user access, exit, exploration or navigation through the application.
login: It is used to request access to the application. It deletes the text string free
and registers your access in Pandora FMS audit or returns the text string denied
if there is another user in the audit records who has previously logged in the system and has not yet logged out. It will also return denied
if the administrator-only access parameter is enabled and the user is not an admin.
logout: Logs a user's application logout so that other users are again allowed to access.
browse: It must be used on all pages of the external application, as it checks whether this user is still the last one to access or be expelled from the application.
exclude: It expels the currently registered user and registers the access of another one sent in the user_id parameter
IP address of the application from which you access it. It is registered and checked in the Pandora FMS audit to check user access status in the application.
Name of the application you are accessing from. It is registered and checked in the Pandora FMS audit to check the user access status in the application.
It forbids the access to non-administrator users.
Example (requires adapted environment)
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=access_process&other=1%7Clogin%7C192.168.50.25%7Cexternal_app%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It creates a new event response.
op=set
(required).op2=create_event_response
(required).return_type=csv
or return_type=json
(one of two required)other=
< serialized parameters > (all required). In the following order:command
, here it is necessary to indicate the desired command to execute the response to the event. On the other hand, if it is url
, indicate the URL you wish to access as a response to the event.command
or url
.1
or 0
. It indicates whether the URL is shown on a new window (1
) or on a modal window (0
).0
.Example (see call syntax):
…/include/api.php?op=set&op2=create_event_response&other=response|description%20response|touch|command|0|650|400|0|response|0|90&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
It edits an existing event response. The user must have permissions on the group to which the response belongs, in order to edit it.
Call syntax:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=update_event_response&id=5&other=response|description%20response|touch|command|0|650|400|0|response|0|90&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
It deletes an event response. The user must have permissions on the group to which the response belongs in order to delete it.
Call syntax:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_event_response&id=7&apipass=1234&user=admin&pass=pandora
It creates a new user profile.
Call syntax:
IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.
To know which permissions should be activated, click on this link.
Example
This example creates a profile that gives read-only access to Pandora, that is, it is the same as the predefined profile Operator (read).
http://localhost/pandora_console/include/api.php?op=set&op2=create_user_profile_info&return_type=json&other=API_profile%7C1%7C0%7C0%7C1%7C0%7C0%7C0%7C0%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It updates a new existing user profile.
Call syntax:
IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.
To find out which permissions should be activated, click on this link.
Example
In this example the name of the profile with ID 6 is replaced by API_profile_updated and it is granted all permissions (read, write and management) related to agents and permission to read events is withdrawn.
http://localhost/pandora_console/include/api.php?op=set&op2=update_user_profile_info&return_type=json&id=6&other=API_profile_updated%7C%7C%7C%7C1%7C1%7C1%7C%7C%7C%7C%7C0%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It deletes a user profile. It also deletes all that profile assignments to any user.
Call syntax:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_profile_info&return_type=json&id=8&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It creates an event filter.
Call syntax:
["tag_id_1", "tag_id_2", "tag_id_3", "…"]
)
["tag_id_1", "tag_id_2", "tag_id_3", "…"]
)
Examples
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event_filter&id=test&other=%7C%7Cerror%7C4%7C%7C%7C1%7C%7C12%7C%7C%7C2018-12-09%7C2018-12-13%7C[%226%22]%7C[%2210%22,%226%22,%223%22]%7C1%7C10%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It updates an event filter.
Call syntax:
["tag_id_1", "tag_id_2", "tag_id_3", "…"]
)
["tag_id_1", "tag_id_2", "tag_id_3", "…"]
)
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_event_filter&id=195&other=new_name%7C%7C%7Calert_recovered%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It deletes an event filter.
Call syntax:
Example
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_event_filter&id=38&apipass=1234&user=admin&pass=pandora
It returns the list of existing event filters.
Call syntax:
Examples
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
It creates a new inventory module.
Call syntax:
Example
This example creates an inventory module called OS that collects the kernel-name and nodename data from a Linux system.
http://localhost/pandora_console/include/api.php?op=set&op2=create_inventory_module&return_type=json&other=OS%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It updates an inventory module.
Call syntax:
Example
http://localhost/pandora_console/include/api.php?op=set&op2=update_inventory_module&return_type=json&id=42&other=OS_easy%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It deletes a user profile. It also deletes all assignments from that profile to any user.
Call syntax:
Examples
http://localhost/pandora_console/include/api.php?op=set&op2=delete_inventory_module&return_type=json&id=42&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
It creates a collection.
Call syntax:
It is necessary to pair it with 'other_mode' as follows: other_mode=url_encode_separator_<separator> to pass the separator of the serialized values of other.
Examples
http://localhost/pandora_console/include/api.php?op=set&op2=create_collection&other=test_plugin|test_p|0|test&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
It deletes a collection.
Call syntax:
Examples
http://localhost/pandora_console/include/api.php?op=set&op2=delete_collection&id=15&apipass=1234&user=admin&pass=pandora
Enables or disables a task in the Discovery Task list.
Call syntax:
Examples
http://localhost/pandora_console/include/api.php?op=set&op2=enable_disable_discovery_task&id=1&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
Adds a Module to the target policy by means of a definition made in JSON format.
Call syntax:
{ name: <value>, // mandatory id_module: <value>, // mandatory id_tipo_modulo: <value>, // mandatory configuration_data: <value>, description: <value>, unit: <value>, max: <value>, min: <value>, module_interval: <value>, ip_target: <value>, tcp_port: <value>, tcp_send: <value>, tcp_rcv: <value>, snmp_community: <value>, snmp_oid: <value>, id_module_group: <value>, flag: <value>, disabled: <value>, id_export: <value>, plugin_user: <value>, plugin_pass: <value>, plugin_parameter: <value>, id_plugin: <value>, post_process: <value>, prediction_module: <value>, max_timeout: <value>, max_retries: <value>, custom_id: <value>, history_data: <value>, min_warning: <value>, max_warning: <value>, str_warning: <value>, min_critical: <value>, max_critical: <value>, str_critical: <value>, min_ff_event: <value>, custom_string_1: <value>, custom_string_2: <value>, custom_string_3: <value>, custom_integer_1: <value>, custom_integer_2: <value>, pending_delete: <value>, critical_instructions: <value>, warning_instructions: <value>, unknown_instructions: <value>, critical_inverse: <value>, warning_inverse: <value>, id_category: <value>, module_ff_interval: <value>, quiet: <value>, cron_interval: <value>, macros: <value>, disabled_types_event: { "going_unknwon": 1, // Disable going unknown events. }, module_macros: <value>, min_ff_event_normal: <value>, min_ff_event_warning: <value>, min_ff_event_critical: <value>, ff_type: <value>, each_ff: <value>, ff_timeout: <value>, dynamic_interval: <value>, dynamic_max: <value>, dynamic_min: <value>, dynamic_next: <value>, dynamic_two_tailed: <value>, prediction_sample_window: <value>, prediction_samples: <value>, prediction_threshold: <value>, cps: <value>, }
Examples
In JSON format before converting to base64:
{ "id_tipo_modulo": 1, "id_modulo": 10, "name": "sample module", "description": "Module created by API", "configuration_data": "module_begin\nmodule_name sample module\nmodule_type generic_data\nmodule_exec echo 1\nmodule_end", "min_warning": 2, "max_warning": 5, "min_critical": 5, "max_critical": 7 }
Once base64 encoded:
http://localhost/pandora_console/include/api.php?op=set&op2=create_module_policy_json&id=1&other=ewogICJpZF90aXBvX21vZHVsbyI6IDEsCiAgImlkX21vZHVsbyI6IDEwLAogICJuYW1lIjogInNhbXBsZSBtb2R1bGUiLAogICJkZXNjcmlwdGlvbiI6ICJNb2R1bGUgY3JlYXRlZCBieSBBUEkiLAogICJjb25maWd1cmF0aW9uX2RhdGEiOiAibW9kdWxlX2JlZ2luXG5tb2R1bGVfbmFtZSBzYW1wbGUgbW9kdWxlXG5tb2R1bGVfdHlwZSBnZW5lcmljX2RhdGFcbm1vZHVsZV9leGVjIGVjaG8gMVxubW9kdWxlX2VuZCIsCiAgIm1pbl93YXJuaW5nIjogMiwKICAibWF4X3dhcm5pbmciOiA1LAogICJtaW5fY3JpdGljYWwiOiA1LAogICJtYXhfY3JpdGljYWwiOiA3Cn0=&apipass=pandora&user=admin&pass=pandora
Update a existing Module to the target policy by means of a definition made in JSON format.
Call syntax:
{ name: <value>, // mandatory id_module: <value>, // mandatory id_tipo_modulo: <value>, // mandatory configuration_data: <value>, description: <value>, unit: <value>, max: <value>, min: <value>, module_interval: <value>, ip_target: <value>, tcp_port: <value>, tcp_send: <value>, tcp_rcv: <value>, snmp_community: <value>, snmp_oid: <value>, id_module_group: <value>, flag: <value>, disabled: <value>, id_export: <value>, plugin_user: <value>, plugin_pass: <value>, plugin_parameter: <value>, id_plugin: <value>, post_process: <value>, prediction_module: <value>, max_timeout: <value>, max_retries: <value>, custom_id: <value>, history_data: <value>, min_warning: <value>, max_warning: <value>, str_warning: <value>, min_critical: <value>, max_critical: <value>, str_critical: <value>, min_ff_event: <value>, custom_string_1: <value>, custom_string_2: <value>, custom_string_3: <value>, custom_integer_1: <value>, custom_integer_2: <value>, pending_delete: <value>, critical_instructions: <value>, warning_instructions: <value>, unknown_instructions: <value>, critical_inverse: <value>, warning_inverse: <value>, id_category: <value>, module_ff_interval: <value>, quiet: <value>, cron_interval: <value>, macros: <value>, disabled_types_event: { "going_unknwon": 1, // Disable going unknown events. }, module_macros: <value>, min_ff_event_normal: <value>, min_ff_event_warning: <value>, min_ff_event_critical: <value>, ff_type: <value>, each_ff: <value>, ff_timeout: <value>, dynamic_interval: <value>, dynamic_max: <value>, dynamic_min: <value>, dynamic_next: <value>, dynamic_two_tailed: <value>, prediction_sample_window: <value>, prediction_samples: <value>, prediction_threshold: <value>, cps: <value>, }
Examples
In JSON format before converting to base64:
{ "id_tipo_modulo": 1, "id_modulo": 1, "name": "name edited", "description": "Module created by API", "configuration_data": "module_begin\nmodule_name sample module\nmodule_type generic_data\nmodule_exec echo 1\nmodule_end", "min_warning": 3, "max_warning": 6, "min_critical": 6, "max_critical": 8 }
Once base64 encoded:
http://localhost/pandora_console/include/api.php?op=set&op2=update_module_policy_json&id=1&id2=43&other=ewogICJpZF90aXBvX21vZHVsbyI6IDEsCiAgImlkX21vZHVsbyI6IDEsCiAgIm5hbWUiOiAibmFtZSBlZGl0ZWQiLAogICJkZXNjcmlwdGlvbiI6ICJNb2R1bGUgY3JlYXRlZCBieSBBUEkiLAogICJjb25maWd1cmF0aW9uX2RhdGEiOiAibW9kdWxlX2JlZ2luXG5tb2R1bGVfbmFtZSBzYW1wbGUgbW9kdWxlXG5tb2R1bGVfdHlwZSBnZW5lcmljX2RhdGFcbm1vZHVsZV9leGVjIGVjaG8gMVxubW9kdWxlX2VuZCIsCiAgIm1pbl93YXJuaW5nIjogMywKICAibWF4X3dhcm5pbmciOiA2LAogICJtaW5fY3JpdGljYWwiOiA2LAogICJtYXhfY3JpdGljYWwiOiA4Cn0=&apipass=pandora&user=admin&pass=pandora
To set a custom identifier in an event.
op=get
(required).op2=set
(required).id=
< id_event > (required, numerical value).id2=
< id_custom_event > (required, alphanumeric value).other=
< id_node > If running in Command Center (Metaconsole), the node identifier. Default value 0
(Command Center).Example (see call syntax):
…/include/api.php?op=set&op2=event_custom_id&id=110&id2=9999&apipass=1234&user=admin&pass=pandora
Example for a node in Command Center:
…/include/api.php?op=set&op2=event_custom_id&id=3831949&id2=Test123&other=1&apipass=1234&user=admin&pass=pandora
These are several examples in several languages about calling Pandora FMS API.
<?php $ip = '192.168.70.110'; $pandora_url = '/pandora5'; $apipass = '1234'; $user = 'admin'; $password = 'pandora'; $op = 'get'; $op2 = 'all_agents'; $return_type = 'csv'; $other = ''; $other_mode = ''; $url = "http://" . $ip . $pandora_url . "/include/api.php"; $url .= "?"; $url .= "apipass=" . $apipass; $url .= "&user=" . $user; $url .= "&pass=" . $password; $url .= "&op=" . $op; $url .= "&op2=" . $op2; if ($id !== '') { $url .= "&id=" . $id; } if ($id2 !== '') { $url .= "&id2=" . $id2; } if ($return_type !== '') { $url .= "&return_type=" . $return_type; } if ($other !== '') { $url .= "&other_mode=" . $other_mode; $url .= "&other=" . $other; } $curlObj = curl_init(); curl_setopt($curlObj, CURLOPT_URL, $url); curl_setopt($curlObj, CURLOPT_RETURNTRANSFER, 1); $result = curl_exec($curlObj); curl_close($curlObj); $agents = array(); if (!empty($result)) { $lines = explode("\n", $result); foreach ($lines as $line) { $fields = explode(";", $line); $agent = array(); $agent['id_agent'] = $fields[0]; $agent['name'] = $fields[1]; $agent['ip'] = $fields[2]; $agent['description'] = $fields[3]; $agent['os_name'] = $fields[4]; $agent['url_address'] = $fields[5]; $agents[] = $agent; } } print_list_agents($agents); function print_list_agents($agents) { echo "<table border='1' style='empty-cells: show;'>"; echo "<thead>"; echo "<tr>"; echo "<th>" . "ID" . "</th>"; echo "<th>" . "Name" . "</th>"; echo "<th>" . "IP" . "</th>"; echo "<th>" . "Description" . "</th>"; echo "<th>" . "OS" . "</th>"; echo "<th>" . "URL" . "</th>"; echo "</tr>"; echo "</thead>"; foreach ($agents as $agent) { echo "<tr>"; echo "<td>" . $agent['id_agent'] . "</td>"; echo "<td>" . $agent['name'] . "</td>"; echo "<td>" . $agent['ip'] . "</td>"; echo "<td>" . $agent['description'] . "</td>"; echo "<td>" . $agent['os_name'] . "</td>"; echo "<td>" . $agent['url_address'] . "</td>"; echo "</tr>"; } echo "</table>"; } ?>
import pycurl import cStringIO import pprint def main(): ip = '192.168.70.110' pandora_url = '/pandora5' apipass = '1234' user = 'admin' password = 'pandora' op = 'get' op2 = 'all_agents' return_type = 'csv' other = '' other_mode = '' url = "http://" + ip + pandora_url + "/include/api.php" url += "?" url += "apipass=" + apipass url += "&user=" + user url += "&pass=" + password url += "&op=" + op url += "&op2=" + op2 buf = cStringIO.StringIO() c = pycurl.Curl() c.setopt(c.URL, url) c.setopt(c.WRITEFUNCTION, buf.write) c.perform() output = buf.getvalue() buf.close() lines = output.split("\n") agents = [] for line in lines: if not line: continue fields = line.split(";") agent = {} agent['id_agent'] = fields[0] agent['name'] = fields[1] agent['ip'] = fields[2] agent['description'] = fields[3] agent['os_name'] = fields[4] agent['url_address'] = fields[5] agents.append(agent) for agent in agents: print("---- Agent #" + agent['id_agent'] + " ----") print("Name: " + agent['name']) print("IP: " + agent['ip']) print("Description: " + agent['description']) print("OS: " + agent['os_name']) print("URL: " + agent['url_address']) print("") if __name__ == "__main__": main()
use strict; use warnings; use WWW::Curl::Easy; sub write_callback { my ($chunk,$variable) = @_; push @{$variable}, $chunk; return length($chunk); } my $ip = '192.168.70.110'; my $pandora_url = '/pandora5'; my $apipass = '1234'; my $user = 'admin'; my $password = 'pandora'; my $op = 'get'; my $op2 = 'all_agents'; my $return_type = 'csv'; my $other = ''; my $other_mode = ''; my $url = "http://" . $ip . $pandora_url . "/include/api.php"; $url .= "?"; $url .= "apipass=" . $apipass; $url .= "&user=" . $user; $url .= "&pass=" . $password; $url .= "&op=" . $op; $url .= "&op2=" . $op2; my @body; my $curl = WWW::Curl::Easy->new; $curl->setopt(CURLOPT_URL, $url); $curl->setopt(CURLOPT_WRITEFUNCTION, \&write_callback); $curl->setopt(CURLOPT_FILE, \@body); $curl->perform(); my $body=join("",@body); my @lines = split("\n", $body); foreach my $line (@lines) { my @fields = split(';', $line); print("\n---- Agent #" . $fields[0] . " ----"); print("\nName: " . $fields[1]); print("\nIP: " . $fields[2]); print("\nDescription: " . $fields[3]); print("\nOS: " . $fields[4]); print("\n"); }
require 'open-uri' ip = '192.168.70.110' pandora_url = '/pandora5' apipass = '1234' user = 'admin' password = 'pandora' op = 'get' op2 = 'all_agents' return_type = 'csv' other = '' other_mode = '' url = "http://" + ip + pandora_url + "/include/api.php" url += "?" url += "apipass=" + apipass url += "&user=" + user url += "&pass=" + password url += "&op=" + op url += "&op2=" + op2 agents = [] open(url) do |content| content.each do |line| agent = {} tokens = line.split(";") agent[:id_agent] = tokens[0] agent[:name] = tokens[1] agent[:ip] = tokens[2] agent[:description] = tokens[3] agent[:os_name] = tokens[4] agent[:url_address] = tokens[5] agents.push agent end end agents.each do |agent| print("---- Agent #" + (agent[:id_agent] || "") + " ----\n") print("Name: " + (agent[:name] || "") + "\n") print("IP: " + (agent[:ip] || "") + "\n") print("Description: " + (agent[:description] || "") + "\n") print("OS: " + (agent[:os_name] || "") + "\n") print("URL: " + (agent[:url_address] || "") + "\n") print("\n") end
require("curl") local content = "" function WriteMemoryCallback(s) content = content .. s return string.len(s) end ip = '192.168.70.110' pandora_url = '/pandora5' apipass = '1234' user = 'admin' password = 'pandora' op = 'get' op2 = 'all_agents' return_type = 'csv' other = '' other_mode = '' url = "http://" .. ip .. pandora_url .. "/include/api.php" url = url .. "?" url = url .. "apipass=" .. apipass url = url .. "&user=" .. user url = url .. "&pass=" .. password url = url .. "&op=" .. op url = url .. "&op2=" .. op2 if curl.new then c = curl.new() else c = curl.easy_init() end c:setopt(curl.OPT_URL, url) c:setopt(curl.OPT_WRITEFUNCTION, WriteMemoryCallback) c:perform() for line in string.gmatch(content, "[^\n]+") do line = string.gsub(line, "\n", "") count = 0 for field in string.gmatch(line, "[^\;]+") do if count == 0 then print("---- Agent #" .. field .. " ----") end if count == 1 then print("Name: " .. field) end if count == 2 then print("IP: " .. field) end if count == 3 then print("Description: " .. field) end if count == 4 then print("OS: " .. field) end if count == 5 then print("URL: " .. field) end count = count + 1 end print("") end
[-]>[-]<>+++++++++[<+++++++++>-]<-.>+++++[<+++++>-]<----.>++++[<++++>-]<---. >++++[<---->-]<++. >+++[<+++>-]<++. -.>++++++++[<-------->-]<--.>+++[<--->-]<---.>++++++++[<++++++++>-]<++++. +.>++++++++[<-------->-]<-----.>+++++++++[<+++++++++>-]<----. ++. --.>+++[<--->-]<+.>+++[<+++>-]<.>++[<++>-]<++. >++[<-->-]<-. >+++++++++[<--------->-]<++. >+++++++++[<+++++++++>-]<---. +.>+++++++++[<--------->-]<++.>+++++++++[<+++++++++>-]<+++.>++++[<---->-]<+. >+++[<+++>-]<. >+++[<--->-]<++. >+++[<+++>-]<-. >+++++++++[<--------->-]<++. >+++++++++[<+++++++++>-]<+++. >+++[<--->-]<--. ----.>+++[<+++>-]<-. +++. -.>+++++++++[<--------->-]<++.>+++++++++[<+++++++++>-]<-.>++++[<---->-]<+. >++++[<++++>-]<+. >++++[<---->-]<-. >++++++++[<-------->-]<-. >++++++++[<++++++++>-]<++++++++. >+++[<--->-]<++. ++. ++.>++++[<++++>-]<---.>++[<-->-]<--. +++.>++++++++[<-------->-]<---.>+++[<--->-]<---.>+++++++++[<+++++++++>-]<-. >+++[<--->-]<--. >++++[<++++>-]<---. ---.>+++++++++[<--------->-]<++.>+++++++++[<+++++++++>-]<+++++.>+++++[<----->-]<++++. >+++[<+++>-]<++. >+++[<--->-]<++. >++++++++[<-------->-]<-----. >+++++++++[<+++++++++>-]<----. >+++[<+++>-]<-. >++++[<---->-]<--. >++[<++>-]<+. >+++[<+++>-]<--. ++++.>+++++++++[<--------->-]<--.>++++++++[<++++++++>-]<++++++.>+++[<+++>-]<+++. >+++[<--->-]<. ++. --.>+++[<+++>-]<--.>++[<++>-]<+.>+++[<--->-]<++. >++[<++>-]<++. >++[<-->-]<-. ++++.>++++++++[<-------->-]<-----.
See our project (Pandora FMS Event Viewer) in Pandroid FMS Event Viewer source code in SourceForge SVN repository but this is the most important piece of code, which calls the API to get event data.
/** * Performs an http get petition. * * @param context * Application context. * @param additionalParameters * Petition additional parameters * @return Petition result. * @throws IOException * If there is any problem with the connection. */ public static String httpGet(Context context, List<NameValuePair> additionalParameters) throws IOException { SharedPreferences preferences = context.getSharedPreferences( context.getString(R.string.const_string_preferences), Activity.MODE_PRIVATE); String url = preferences.getString("url", "") + "/include/api.php"; String user = preferences.getString("user", ""); String password = preferences.getString("password", ""); String apiPassword = preferences.getString("api_password", ""); if (url.length() == 0 || user.length() == 0) { return ""; } ArrayList<NameValuePair> parameters = new ArrayList<NameValuePair>(); parameters.add(new BasicNameValuePair("user", user)); parameters.add(new BasicNameValuePair("pass", password)); if (apiPassword.length()> 0) { parameters.add(new BasicNameValuePair("apipass", apiPassword)); } parameters.addAll(additionalParameters); Log.i(TAG, "sent: " + url); if (url.toLowerCase().contains("https")) { // Secure connection return Core.httpsGet(url, parameters); } else { HttpParams params = new BasicHttpParams(); HttpConnectionParams.setConnectionTimeout(params, CONNECTION_TIMEOUT); HttpConnectionParams.setSoTimeout(params, CONNECTION_TIMEOUT); DefaultHttpClient httpClient = new DefaultHttpClient(params); UrlEncodedFormEntity entity; HttpPost httpPost; HttpResponse response; HttpEntity entityResponse; String return_api; httpPost = new HttpPost(url); entity = new UrlEncodedFormEntity(parameters); httpPost.setEntity(entity); response = httpClient.execute(httpPost); entityResponse = response.getEntity(); return_api = Core .convertStreamToString(entityResponse.getContent()); Log.i(TAG, "received: " + return_api); return return_api; } }
To develop new calls for the API, keep in mind that:
api
, the kind of operation get
, set
or help
(depending on whether it is a data read, data write or retrieve help operation) and the name of the call, trying to be coherent with the operation, as for example: function api_get_[call_name](parameters) .
It is possible to create new API calls without using …/include/functions_api.php
. The process consists of adding into a Pandora FMS extension directory a file with the following name:
<extension_name>.api.php
and into this file create the desired functions with the same considerations of the standard API but with apiextension
prefix instead of api
.
For example, having an extension called module_groups
with the path
<Pandora installation>/extensions/module_groups
You must create a file called module_groups.api.php
into this directory.
The desired functions will be within this file, for example a function to get the number of modules in a group. This function must have a name like: apiextension_get_groupmodules
.
In this function, made up functions have been used.
function apiextension_get_groupmodules($group_name) { $group_id = group_id_from_name($group_name); if($group_id == false) { echo 'Group doesnt exist'; return; } $number_of_modules = group_modules($group_id); echo $number_of_modules; }
This call example gets the number of modules of the Servers
group.
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora
The following functions could be used in your call function code:
function api_get_module_last_value($idAgentModule, $trash1, $other = ';', $returnType) { $sql = sprintf('SELECT datos FROM tagente_estado WHERE id_agente_modulo = %d', $idAgentModule); $value = get_db_value_sql($sql); if ($value === false) { switch ($other['type']) { case 'string': switch ($other['data']) { case 'error_message': default: returnError('id_not_found', $returnType); break; } break; case 'array': switch ($other['data'][0]) { case 'error_value': returnData($returnType, array('type' => 'string', 'data' => $other['data'][1])); break; } break; } } else { $data = array('type' => 'string', 'data' => $value); returnData($returnType, $data); } }
Some ideas for the future of api.php are: