Pandora:Documentation en:Annex ExternalAPI

Go back to Pandora FMS documentation index

1 Pandora FMS External API

The Pandora FMS External API is used doing remote calls (through HTTP) 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.php is as simple as this:

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

The API can only receive the following parameters:

• op (required): It is the first parameter that specifies the nature of the operation, which could be "get" or "set" or "help":

• get: It returns a value or values.
• set: It sends a value or values.
• help: It returns a little help from the calls

• op2 (required): The call with an explanatory name of the one that it works on.
• id (optional): The first call parameter.
• id2 (optional): The second call parameter.
• other (optional): The third call parameter, sometimes it could be a list of serial values.
• other_mode (optional): Serial format. list of posible values:

• url_encode: the othervalue is an alphanumeric formtted as UrlEncode.
• url_encode_separator_<separador>: The value will be a serial value list with the divider character, for example:

...other=peras|melones|sandias&other_mode=url_encode_separator_|

• returnType (optional): return format of the value or values. The current available values are:

• 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.

1.1 Security

At the moment, security is based on an IP list that will have access to the tool. And it will be configured as seen in the image, in Pandora FMS Console configuration options.

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.

In order to setup the password, follow these steps:

• apipass: Api password configured in the console. Do it in the following configuration view (Administration>Setup>):

Nota: Before version 4.0.2, this parameter was pass

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

• user: Valid Pandora FMS user

• pass: The user password

Note: In API calls, passwords are uncoded. Be careful and use SSL connections to avoid sniffers. The API allows POST petitions to encrypt them when using SSL/HTTPS.

1.1.1 Return

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

1.1.2 Examples

In this case, the API password 1234 is used. The user is admin and the password is pandora.

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

Access conditions:

• The source IP is in the ACLs IP list
• The API password is not set or is 1234
• The user admin exists and its password is pandora

1.1.3 Security Workflow

Starting from version 4.0.2, the API will have several security improvements, and this is implemented by three factors:

• IP filtering. Only listed / filtered IP will be allowed to connect to the API.
• Global API password, if defined, needed to use the API.
• User & password valid in the console. Permissions will be used each time there is a requested operation.

It is explained in this workflow:

1.2 New calls extension in the API

To develop new calls for the API, keep in mind that:

• The call has to be inscribed as a function in the file <installation Pandora FMS Console>/include/functions_api.php .

• The function must have this structure: The prefix "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) .
• The function can have no parameters, but if it has them, the parameters received will be the following in the same order:
• id: first operator or parameter, it contains a string.
• id2: second operator or parameter, it contains a string.
• other: rest of operators or parameters, it contains as an array of two positions:

• $other['type']: That might be be a string or an array.
• $other['data']: That will be a string with the parameter or an array of numeric index with the past parameters.

• returnType: string that specifies the kind of return that the call will have. It is usually visible for you, but you may use or modify it if necessary.

1.2.1 New Calls in the API from Pandora FMS extensions

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, 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".

1.2.1.1 Function example

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;
}

1.2.1.2 Call example

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

1.2.2 API Functions

The following functions could be used in your call function code:

• returnError(typeError, returnType): It gives back an error in an standardized way for all calls.

• typeError: By now 'id_not_found' or null.
• returnType: By now 'string' or error message.

• returnData(returnType, data, separator): It is the function that returns the API call data.

• returnType: That could be 'string', 'csv', 'csv_head'
• data: It is an array that contains the data, as well as its format. It has the following fields:

• 'type' (required): It could be 'string' and 'array'.
• 'list_index' (optional): It contains a numeric index array containing the alphanumeric index to be taken out through exit.
• 'data' (required): It contains a string with the data or an array of alphanumeric index or numeric index with data.

1.2.3 Example

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);
	}
}

1.3 API Calls

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.

1.3.1 INFO RETRIEVING

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 v5.0 - PC131015

1.3.2 GET

It returns the required data.

1.3.2.1 get test

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

This feature is in Metaconsole.

Call syntax: Without parameters

1.3.2.1.1 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

1.3.2.2 get license

>= 7.0NG 752

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

Call syntax:

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

1.3.2.2.1 Examples

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

For Community version, it returns:

{
 "type":"array",
 "data":{
  "license_mode":"PANDORA-FREE",
 }
}

1.3.2.3 get all_agents

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

Call syntax:

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

• <filter_so>
• <filter_group>
• <filter_module_states>
• <filter_alias>
• <filter_policy>
• <csv_separator>
• Recursion (1 or 0)

1.3.2.3.1 Examples

This example will return all agents whose id_os is equal to 1, id_group equals 2, state equal to warning, their alias contains 'j', and the policy associated equals 2.

CSV example: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
JSON example: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

1.3.2.4 get license_remaining

>= 7.0NG 752

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

Call syntax:

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

1.3.2.4.1 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

1.3.2.5 get module_last_value

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

Call syntax:

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

• Error return codes are:

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

1.3.2.5.1 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

1.3.2.6 get agent_module_name_last_value

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

Call Syntax:

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

• Codes of error return are:

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

1.3.2.6.1 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

1.3.2.7 get agent_module_name_last_value_alias

=> 7.0NG

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

Call Syntax:

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

• Codes of error return are:

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

1.3.2.7.1 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

1.3.2.8 get module_value_all_agents

It returns a list of agent and module values, these modules are in all of the agents of the list and they are filtered by the name of module which has gone through the id parameter.

Call syntax:

• op=get (required)
• op2=module_value_all_agents (required)
• id=<name of the module> (required). This is the module name.

1.3.2.8.1 Examples

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

1.3.2.9 get agent_modules

It returns the list of agent modulest, this agent is filtered by the id agent which has gone through id parameter.

Call syntax:

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

• <id_agent>

The 'other_mode' parameter must be completed like this other_mode=url_encode_separator_<separador> in order to configure the separator in other field.

1.3.2.9.1 Examples

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

1.3.2.10 get module_id

It returns the id of an agent module.

Call syntax:

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

1.3.2.10.1 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

1.3.2.11 get module_custom_id

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

Call syntax:

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

1.3.2.11.1 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

1.3.2.12 set module_custom_id

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

Call syntax:

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

1.3.2.12.1 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

1.3.2.13 get locate_agent

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

Call syntax:

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

1.3.2.13.1 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

1.3.2.14 get policies

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

Call syntax:

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

• <id_agent>

1.3.2.14.1 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

1.3.2.15 get tree_agents

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

Call Syntax:

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

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

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

• <fields 1>,<fields2>,<fields N&gt :the fields to show in the CSV are:

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

1.3.2.15.1 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

1.3.2.16 get module_data

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

Call syntax:

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

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

1.3.2.16.1 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

1.3.2.17 get graph_module_data

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

Call syntax:

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

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

1.3.2.17.1 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

1.3.2.18 get events

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

Call syntax:

• op=get (required)
• op2=events (required)
• return_type=csv (required)
• other_mode=url_encode_separator_| (optional)
• other=<serialized parameters> (optional). They are the following in this order:

• <separator>
• <criticity> Values from 0 to 4, or -1 to avoid this param
• <agent alias>
• <module name>
• <alert template name>
• <user>
• <numeric interval minimum level > in unix timestamp
• <numeric interval maximum level > in unix timestamp
• <status>
• <event substring>
• <register limit>
• <offset register>
• <optional style [total|more_criticity]> (total - it returns the number of the records, more_criticity - it returns the highest criticity value)
• <id_grupo>
• <tags>
• <event type> unknown, alert_fired, alert_recovered,.. or its substring. You may also use 'not_normal'.

1.3.2.18.1 Examples

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora

1.3.2.19 get all_alert_templates

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

Call syntax:

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

1.3.2.19.1 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

1.3.2.20 get module_groups

It returns the list of module groups.

Call syntax:

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

1.3.2.20.1 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

1.3.2.21 get plugins

It returns the list of Pandora FMS server plugins.

Call syntax:

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

1.3.2.21.1 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

1.3.2.22 get tags

It returns the list of tags defined in Pandora FMS.

Call syntax:

• op=get (required)
• op2=tags (required)
• return_type=csv (required)

1.3.2.22.1 Examples

This example will return all tags in the system.

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

1.3.2.23 get module_from_conf

>= 5.0 (Only Enterprise)

It returns the configuration of a local module.

Call syntax:

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

1.3.2.23.1 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.

1.3.2.24 get total_modules

Total modules by group.

Call syntax:

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

1.3.2.24.1 Examples

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

If the group id is 0, it returns the total amount of modules.

1.3.2.25 get total_agents

Total agents by group.

Call syntax:

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

1.3.2.25.1 Examples

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

1.3.2.26 get agent_name

Agent name for a given id

Call syntax:

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

1.3.2.26.1 Examples

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

1.3.2.27 get agent_alias

>= 7.0NG

Agent alias for a given id.

Call syntax:

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

1.3.2.27.1 Examples

• Node:

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

• Metaconsole:

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

1.3.2.28 get module_name

Module name for a given id.

Call syntax:

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

1.3.2.28.1 Examples

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

1.3.2.29 get alert_action_by_group

Total alert execution with an action by group.

Call syntax:

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

1.3.2.29.1 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

1.3.2.30 get alert_actions

List of alert actions

Call syntax:

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

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

1.3.2.30.1 Examples

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

1.3.2.31 get alert_actions_meta

This feature is in Metaconsole.

List of node alert actions from Metaconsole.

Call syntax:

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

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

1.3.2.31.1 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

1.3.2.32 get all_alert_commands

It returns all the alert commands.

Call syntax:

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

1.3.2.32.1 Examples

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

1.3.2.33 get event_info

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

This feature is in Metaconsole.

Call syntax:

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

1.3.2.33.1 Examples

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

1.3.2.34 get tactical_view

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

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

Call syntax:

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

1.3.2.34.1 Example

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

1.3.2.35 get pandora_servers

>= 5.0

It returns the list of Pandora FMS servers.

Call syntax:

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

1.3.2.35.1 Example

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

It returns the fields in this order:

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

1.3.2.36 get custom_field_id

>= 5.0

It translates the name of custom field into the id in the data base.

Call syntax:

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

• <name> (required)

1.3.2.36.1 Example

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

1.3.2.37 get gis_agent

>= 5.0

It returns the last GIS agent data.

Call syntax:

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

1.3.2.37.1 Example

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

1.3.2.38 get special_days

>= 5.1

It returns special day's list.

Call syntax:

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

1.3.2.38.1 Example

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

1.3.2.39 get module_properties

>= 5.1SP2

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

Call Syntax:

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

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

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

• module_id_agent_module
• module_id_agent
• module_id_module_type
• module_description
• module_name
• module_max
• module_min
• module_interval
• module_tcp_port
• module_tcp_send
• module_tcp_rcv
• module_snmp_community
• module_snmp_oid
• module_ip_target
• module_id_module_group
• module_flag
• module_id_module
• module_disabled
• module_id_export
• module_plugin_user
• module_plugin_pass
• module_plugin_parameter
• module_id_plugin
• module_post_process
• module_prediction_module
• module_max_timeout
• module_custom_id
• module_history_data
• module_min_warning
• module_max_warning
• module_min_critical
• module_max_critical
• module_min_ff_event
• module_delete_pending
• module_id_agent_state
• module_data
• module_timestamp
• module_state
• module_last_try
• module_utimestamp
• module_current_interval
• module_running_by
• module_last_execution_try
• module_status_changes
• module_last_status
• module_plugin_macros
• module_macros
• module_critical_inverse (only in version 6.0SP1 or later)
• module_warning_inverse (only in version 6.0SP1 or later)

1.3.2.39.1 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

1.3.2.40 get module_properties_by_name

>= 5.1SP2

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

Call Syntax:

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

1.3.2.40.1 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

1.3.2.41 get module_properties_by_alias

>= 7.0NG

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

Call Syntax:

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

1.3.2.41.1 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

1.3.2.42 get module_graph

It returns a Module graph encoded with base64..

Call Syntax:

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

From version NG 752 onwards, more parameters are available, please pay attention to the mandatory fields and their separators | or its [Escape character https://en.wikipedia.org/wiki/Escape_character]  %7C .

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

1.3.2.42.1 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

1.3.2.43 get all_planned_downtimes

>= 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)

1.3.2.43.1 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

1.3.2.44 get planned_downtimes_items

>= 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)

1.3.2.44.1 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

1.3.2.45 get id_group_agent_by_name

>= 5.1

It returns the group id of an agent.

Call Syntax:

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

• <agent_name>

1.3.2.45.1 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

1.3.2.46 get id_group_agent_by_alias

>= 7.0NG

It returns the group id of an agent.

Call Syntax:

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

• <agent_alias>

1.3.2.46.1 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

1.3.2.47 get group_agent_by_name

>= 5.1

It returns the group name for a agent.

Call Syntax:

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

• <agent_name>

1.3.2.47.1 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

1.3.2.48 get group_agent_by_alias

>= 7.0NG

It returns the group name for an agent.

Call Syntax:

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

• <agent_alias>

1.3.2.48.1 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

1.3.2.49 get group_id_by_name

>= 7.0NG

It returns the group id from the name.

Call syntax:

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

• <group_name>

1.3.2.49.1 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

1.3.2.50 get_timezone

>= 7.0NG

It returns the timezone with which pandora is configured.

Call syntax:

• op=get
• op2=timezone

1.3.2.50.1 Example

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

1.3.2.51 get cluster_status

>= 7.0

It returns the cluster status by id

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

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

1.3.2.52 get cluster_id_by_name

>= 7.0

It returns the id of the cluster by name

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

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

1.3.2.53 get agents_id_name_by_cluster_id

>= 7.0

It returns the id => cluster agents names by cluster id

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

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

1.3.2.54 get agents_id_name_by_cluster_name

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

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

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

1.3.2.55 get modules_id_name_by_cluster_id

>= 7.0

It returns the id => all the module names of the cluster agents by cluster id

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

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

1.3.2.56 get modules_id_name_by_cluster_name

>= 7.0

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

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

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

1.3.2.57 get cluster_items

>= 7.0

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

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

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

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

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

1.3.2.58 get policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.58.1 Example

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

1.3.2.59 get collections_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.59.1 Example

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

1.3.2.60 get plugins_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.60.1 Example

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

1.3.2.61 get inventory_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.61.1 Example

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

1.3.2.62 get unlinking_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.62.1 Example

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

1.3.2.63 get alerts_policy

>= 7.0NG. 725

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

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

Call syntax:

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

1.3.2.63.1 Example

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

1.3.2.64 get alerts_actions_policy

>= 7.0NG. 725

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

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

Call syntax:

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

1.3.2.64.1 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

1.3.2.65 get agents_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.65.1 Example

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

1.3.2.66 get groups_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.66.1 Example

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

1.3.2.67 get queue_policy

>= 7.0NG. 725

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

Call syntax:

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

1.3.2.67.1 Example

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

1.3.2.68 get traps

>= 7.0NG. 728

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

Call syntax:

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

• <timestamp>
• <limit>
• <offset>
• <status>
• <oid_custom>

1.3.2.68.1 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

1.3.2.69 get event_responses

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

Call syntax:

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

1.3.2.69.1 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

1.3.2.70 get users

It returns the list of Pandora FMS users.

Call syntax:

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

1.3.2.70.1 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_&

1.3.2.71 get list all user

This