Schemas ======= AlertPayload ------------ .. code:: json { "alert_name": "string", "alert_template": 0, "description": "string", "enabled": true, "history_retention": 0, "frequency_min": 0, "operator": "string", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "all_alert_enable": true, "email_group_id": 1, "low_alert_enable": true, "low_email_group_id": 1, "med_alert_enable": true, "med_email_group_id": 1, "high_alert_enable": true, "high_email_group_id": 1, "send_trap": false, "snmp_trap_version": 0, "low_send_trap": true, "med_send_trap": true, "high_send_trap": true, "cleared_alert_enable": true, "params": [], "execute_script": true, "execute_script_on_clear": true, "execute_script_on_pem_server": true, "script_code": "string", "submit_to_nagios": true, "override_default_config": true, "send_notification": false, "low_webhook_ids": [], "med_webhook_ids": [], "high_webhook_ids": [], "cleared_webhook_ids": [] } Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_name,string,false,none,Name of the alert. NOTE: This property is a mandatory parameter for a POST request. alert_template,integer,false,none,ID of the alert template. The ID must be a positive integer value. NOTE: This property is a mandatory parameter for a POST request. description,string,false,none,none enabled,boolean,false,none,Defines whether this alert is enabled/disabled. NOTE: This property is a mandatory parameter for a POST request. history_retention,integer,false,none,Specifies how many days to keep the history of this alert. Possible values are from 1 to 99999. NOTE: This property is a mandatory parameter for a POST request. frequency_min,integer,false,none,Defines how frequently (in minutes) the alert must be checked on PEM database server. Possible values are 1 to 65534. NOTE: This property is a mandatory parameter for a POST request. operator,string,false,none,"Defines the operator for checking threshold values. Valid string are "">"" and ""<"". NOTE: This property is a mandatory parameter for the POST request." low_threshold_value,number,false,none,Threshold value for triggering the low alert. This property can be any valid integer/float value. NOTE: It is a mandatory parameter for a POST request. medium_threshold_value,number,false,none,Threshold value for triggering the medium alert. This property can be any valid integer/float value. NOTE: It is a mandatory parameter for a POST request. high_threshold_value,number,false,none,Threshold value for triggering the high alert. This property can be any valid integer/float value. NOTE: It is a mandatory parameter for a POST request. all_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'email_group_id' when the state of the alert changes. email_group_id,integer,false,none,"Defines the email group to which email notification are sent, when the state of the alert changes." low_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'low_email_group_id' when the state of the alert is set to LOW. low_email_group_id,integer,false,none,Defines the email group to which email notifications are sent when the state of the alert changes to LOW. med_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'medium_email_group_id' when the state of the alert is set to MEDIUM. med_email_group_id,integer,false,none,Defines the email group to which email notifications are sent when the state of the alert changes to MEDIUM. high_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'high_email_group_id' when the state of the alert is set to HIGH. high_email_group_id,integer,false,none,Defines the email group to which email notification are sent when the state of the alert changes to HIGH. send_trap,boolean,false,none,Determines whether to send an SNMP trap notification when the state of the alert changes. snmp_trap_version,integer,false,none,"Defines the SNMP trap version. Supported SNMP trap versions are 1, 2 or 3." low_send_trap,boolean,false,none,Determines whether to send SNMP trap notifications when the state of the alert changes to LOW. med_send_trap,boolean,false,none,Determines whether to send SNMP trap notifications when the state of the alert changes to MEDIUM. high_send_trap,boolean,false,none,Determines whether to send SNMP trap notifications when the state of the alert chagnes to HIGH. cleared_alert_enable,boolean,false,none,Determines whether to mute the notification for 'clear alert'. params,\ :ref:`[AlertParams <#tocs_alertparams>` ],false,none,List of parameter/value pairs to be used by the alert template for checking alerts. NOTE: The alert template requires the all parameter to be defined. execute_script,boolean,false,none,Determines whether to execute the provided script if the state of the alert changes to LOW/MEDIUM/HIGH. execute_script_on_clear,boolean,false,none,Determines whether to execute the provided script if the state of the alert clears. execute_script_on_pem_server,boolean,false,none,Determines whether to execute the provided script on the PEM host or the host where the agent is monitoring the object. script_code,string,false,none,The shell or batch script to be executed. Please read the documentation for detailed information. submit_to_nagios,boolean,false,none,"Defines whether to send notification to the nagios, when state of the alert is chagned." override_default_config,boolean,false,none,Determines whether to override the default webhook configuration. send_notification,boolean,false,none,Determines whether the webhook send notification is enabled. low_webhook_ids,[integer],false,none,Defines webhook IDs for which low alerts can be configured. med_webhook_ids,[integer],false,none,Defines webhook IDs for which medium alerts can be configured. high_webhook_ids,[integer],false,none,Defines webhook IDs for which high alerts can be configured. cleared_webhook_ids,[integer],false,none,Defines webhook IDs for which cleared alerts can be configured. Alert ----- .. code:: json { "id": 0, "alert_name": "string", "alert_template": 0, "description": "string", "enabled": true, "history_retention": 0, "frequency_min": 0, "auto_created": true, "template_id": "string", "params": [], "param_names": [ "string" ], "param_types": "string", "params_units": [ "string" ], "threshold_unit": "string", "operator": "string", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "send_email": true, "all_alert_enable": true, "email_group_id": 0, "low_alert_enable": true, "low_email_group_id": 0, "med_alert_enable": true, "med_email_group_id": 0, "high_alert_enable": true, "high_email_group_id": 0, "send_trap": true, "snmp_trap_version": 0, "low_send_trap": true, "med_send_trap": true, "high_send_trap": true, "cleared_alert_enable": true, "execute_script": true, "execute_script_on_clear": true, "execute_script_on_pem_server": true, "script_code": "string", "submit_to_nagios": true, "override_default_config": true, "send_notification": true, "low_webhook_ids": [ 0 ], "med_webhook_ids": [ 0 ], "high_webhook_ids": [ 0 ], "cleared_webhook_ids": [ 0 ] } .. _properties-1: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Alert ID. NOTE: This property is not applicable for a POST request. alert_name,string,false,none,Name of the alert. NOTE: This property is a mandatory parameter for a POST request. alert_template,integer,false,none,ID of the alert template. This property must be a positive integer value. NOTE: It is a mandatory parameter for a POST request. description,string,false,none,none enabled,boolean,false,none,Determines whether this alert is enabled/disabled. NOTE: This property is a mandatory parameter for a POST request. history_retention,integer,false,none,Specifies how many days to keep the history of this alert. Possible values are from 1 to 99999. NOTE: This property is a mandatory parameter for a POST request. frequency_min,integer,false,none,Defines in minutes how frequently the alert must be checked on a PEM database server. Possible values are from 1 to 65534. NOTE: This property is a mandatory parameter for a POST request. auto_created,boolean,false,none,Specifies whether the alert is auto-created. template_id,string,false,none,Defines the alert template. params,\ :ref:`[AlertParams <#tocs_alertparams>` ],false,none,List of parameter/value pairs to be used by the alert template for checking alerts. NOTE: The alert template requires the all parameter to be defined. param_names,[string],false,none,Defines the name of parameters. param_types,string,false,none,Defines the type of parameters. Example: INTEGER/STRING.. params_units,[string],false,none,"Defines the unit used for parameters.Example: 'DAYS','True or False','Hours','Minutes' etc" threshold_unit,string,false,none,"Units used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI." operator,string,false,none,"Defines the operator for checking threshold values. Valid strings are "">"" and ""<"". NOTE: This property is a mandatory parameter for a POST request." low_threshold_value,number,false,none,Threshold value for triggering the low alert. This property can be any valid integer/float value. NOTE: It is a mandatory parameter for the POST request. medium_threshold_value,number,false,none,Threshold value for triggering the medium alert. This property can be any valid integer/float value. NOTE: It is a mandatory parameter for the POST request. high_threshold_value,number,false,none,Threshold value for triggering the high alert. It can be any valid integer/float value. NOTE: It is a mandatory parameter for the POST request. send_email,boolean,false,none,Determines whether to send an email when the state of the alert changes. all_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'email_group_id' when the state of the alert changes. email_group_id,integer,false,none,Defines the email group to which email notification are sent when the state of the alert changes. low_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'low_email_group_id' when the state of the alert is set to LOW. low_email_group_id,integer,false,none,Defines the email group to which email notification are sent when the state of the alert changes to LOW. med_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'medium_email_group_id' when the state of the alert is set to MEDIUM. med_email_group_id,integer,false,none,Defines the email group to which email notification are sent when state of the alert changes to MEDIUM. high_alert_enable,boolean,false,none,Determines whether to send an email notification to the group specified by the parameter 'high_email_group_id' when the state of the alert is set to HIGH. high_email_group_id,integer,false,none,Defines the email group to which email notification are sent when the state of the alert changes to HIGH. send_trap,boolean,false,none,Determines whether to send SNMP trap notifications when the state of the alert changes. snmp_trap_version,integer,false,none,"Defines the SNMP trap version. Supported SNMP trap versions are 1, 2 or 3" low_send_trap,boolean,false,none,Determines whether to send SNMP trap notifications when the state of the alert changes to LOW. med_send_trap,boolean,false,none,Determines whether to send SNMP trap notification when the state of the alert changes to MEDIUM. high_send_trap,boolean,false,none,Determines whether to send SNMP trap notification when the state of the alert changes to HIGH. cleared_alert_enable,boolean,false,none,Determines whether to mute the notification for 'clear alert'. execute_script,boolean,false,none,Determines whether to execute the provided script if the state of the alert changes to LOW/MEDIUM/HIGH. execute_script_on_clear,boolean,false,none,Determines whether to execute the provided script if the state of the alert is cleared. execute_script_on_pem_server,boolean,false,none,Determines whether to execute the provided script on the PEM host or the host where the agent is monitoring the object. script_code,string,false,none,The shell or batch script to be executed. Please read the documentation for detailed information. submit_to_nagios,boolean,false,none,Determines whether to send notification to the nagios when the state of the alert changes. override_default_config,boolean,false,none,Determines whether to override the default webhook configuration. send_notification,boolean,false,none,Determines whether to enable the webhook send notification. low_webhook_ids,[integer],false,none,Webhook IDs for which low alerts are configured med_webhook_ids,[integer],false,none,Webhook IDs for which medium alerts are configured high_webhook_ids,[integer],false,none,Webhook IDs for which high alerts are configured cleared_webhook_ids,[integer],false,none,Webhook IDs for which cleared alerts are configured AlertParams ----------- .. code:: json { "paramname": "Exclude tables smaller than", "paramvalue": "string" } .. _properties-2: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable paramname,string,false,none,Name of the parameter. NOTE: This property must present on the alert template parameter list.Example: paramvalue,string,false,none,Value for the given parameter Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable paramname,Exclude tables smaller than paramname,mount point paramname,Host IP Address paramname,Time interval to monitor paramname,Time since idle paramname,Per CPU utilization (K%) AlertTemplateParams ------------------- .. code:: json { "param_names": "string", "param_types": "string", "params_units": "string" } .. _properties-3: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable param_names,string,false,none,Defines the name of parameters. param_types,string,false,none,Defines the type of parameters. Example: INTEGER/STRING.. params_units,string,false,none,"Defines the unit used for parameters.Example: 'DAYS','True or False','Hours','Minutes' etc" ProbeDependencyParams --------------------- .. code:: json { "internal_name": "string" } .. _properties-4: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable internal_name,string,false,none,Internal name of the probe. AlternateServerProbeCode ------------------------ .. code:: json { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } .. _properties-5: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable server_version_id,integer,false,none,Server version ID for the monitored server server_probe_code,string,false,none,SQL query to run on the specified server version extension_version,integer,false,none,Specifies the extension version. Valid for extension target type DeletedAlternateServerProbeCode ------------------------------- .. code:: json { "server_version_id": 0 } .. _properties-6: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable server_version_id,integer,false,none,Server version ID for the monitored server ProbeColumn ----------- .. code:: json { "pc_id": 0, "pc_unit": "string", "pc_graphable": true } .. _properties-7: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable pc_id,integer,false,none,Column identifier pc_unit,string,false,none,Returns the unit of the column. pc_graphable,boolean,false,none,Determines whether the data of the column is graphable on a chart. ChartExportTemplate ------------------- .. code:: json { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [ 0 ], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [ 0 ], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [ 0 ], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [ {} ], "sel_metrics_T": [ {} ], "sel_metrics_C": [ {} ], "shared": [ 0 ], "shared_all": true } .. _properties-8: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable chart_title,string,false,none,Chart title. NOTE: This property is a mandatory parameter for a POST request. chart_type,string,false,none,Chart catagory. NOTE: This property is a mandatory parameter for a POST request. chart_category,string,false,none,Chart type. NOTE: This property is a mandatory parameter for a POST request. chart_description,string,false,none,Description of the chart. NOTE: This property is a mandatory parameter for a POST request. reference_id,string,false,none,Internal identifier for the chart. chart_level,integer,false,none,Defines the chart level. NOTE: This property is a mandatory parameter for a POST request. chart_line_ext,[integer],false,none,Defines the line chart extrapolation. NOTE: This property is a mandatory parameter for a POST request. chart_line_ext_metric,string,false,none,Defines the line chart extrapolation metrics. NOTE: This property is a mandatory parameter for a POST request. chart_line_ext_metric_options,[integer],false,none,Defines the line chart extrapolation metrics option. NOTE: This property is a mandatory parameter for a POST request. chart_line_ext_opt,string,false,none,Defines the line chart extrapolation options. NOTE: This property is a mandatory parameter for a POST request. chart_line_ext_val,string,false,none,Defines the line chart extrapolation values. NOTE: This property is a mandatory parameter for a POST request. chart_line_extrapolated_type,string,false,none,Defines the line chart extrapolation type. NOTE: This property is a mandatory parameter for a POST request. chart_line_points,integer,false,none,Defines the line chart extrapolation point. chart_line_span,[integer],false,none,Defines the line chart span. NOTE: This property is a mandatory parameter for a POST request. chart_refresh,integer,false,none,Chart refresh time espan,integer,false,none,Chart span line_span,integer,false,none,Chart line span sel_metrics_L,[object],false,none,Defines the line chart metrics and its probes data. sel_metrics_T,[object],false,none,Defines the table chart metrics and its probes data. sel_metrics_C,[object],false,none,Defines the capacity manager chart metrics and its probes data. shared,[integer],false,none,Defines the role ID to which chart was shared. shared_all,boolean,false,none,Determines whether the chart needs to be shared with everyone. DashboardExportTemplate ----------------------- .. code:: json { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [ {} ], "c_charts": [ {} ], "shared": [ 0 ], "shared_all": true } .. _properties-9: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Defines the dashboard name. NOTE: This property is a mandatory parameter for a POST request. descp,string,false,none,Provides the dashboard description. reference_id,string,false,none,Internal identifier for the dashboard font,string,false,none,Defines the dashboard font. font_size,integer,false,none,Defines the dashboard font size. level,integer,false,none,Defines the dashboard level. is_ops,boolean,false,none,Determines whether the dashboard is for ops. show_title,boolean,false,none,Determines whether the dashboard title is shown. design_layout,[object],false,none,Defines the dashboard design layout data. c_charts,[object],false,none,Defines the dependant custom charts and its probes data. shared,[integer],false,none,Defines the role ID to which the dashboard is shared. shared_all,boolean,false,none,Determines whether the dashboard must be shared with everyone CustomDashboardExportData ------------------------- .. code:: json { "dashboards": [ 0 ] } .. _properties-10: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable dashboards,[integer],false,none,List of the dashboard IDs CustomDashboardExportResponseData --------------------------------- .. code:: json { "version": 1, "dashboards": [ { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [ {} ], "c_charts": [ {} ], "shared": [ 0 ], "shared_all": true } ] } .. _properties-11: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the dashboard export dashboards,\ :ref:`[DashboardExportTemplate <#tocs_dashboardexporttemplate>` ],false,none,none CustomDashboardImportPostData ----------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "skip_overwrite_chart": true, "dashboards": [ { "name": "string", "descp": "string", "reference_id": "string", "font": "string", "font_size": 0, "level": 0, "is_ops": true, "show_title": true, "design_layout": [ {} ], "c_charts": [ {} ], "shared": [ 0 ], "shared_all": true } ] } .. _properties-12: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the dashboard export skip_overwrite,boolean,false,none,Determines whether the existing chart can be skipped. skip_overwrite_probe,boolean,false,none,Determines whether the existing dependant probes can be skipped. skip_overwrite_chart,boolean,false,none,Determines whether the existing dependant charts can be skipped. dashboards,\ :ref:`[DashboardExportTemplate <#tocs_dashboardexporttemplate>` ],false,none,none CustomChartExportData --------------------- .. code:: json { "charts": [ 0 ] } .. _properties-13: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable charts,[integer],false,none,List of the chart IDs CustomChartExportResponseData ----------------------------- .. code:: json { "version": 1, "charts": [ { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [ 0 ], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [ 0 ], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [ 0 ], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [ {} ], "sel_metrics_T": [ {} ], "sel_metrics_C": [ {} ], "shared": [ 0 ], "shared_all": true } ] } .. _properties-14: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the chart export charts,\ :ref:`[ChartExportTemplate <#tocs_chartexporttemplate>` ],false,none,none CustomChartImportPostData ------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "charts": [ { "chart_title": "string", "chart_type": "string", "chart_category": "string", "chart_description": "string", "reference_id": "string", "chart_level": 0, "chart_line_ext": [ 0 ], "chart_line_ext_metric": "string", "chart_line_ext_metric_options": [ 0 ], "chart_line_ext_opt": "string", "chart_line_ext_val": "string", "chart_line_extrapolated_type": "string", "chart_line_points": 0, "chart_line_span": [ 0 ], "chart_refresh": 0, "espan": 0, "line_span": 0, "sel_metrics_L": [ {} ], "sel_metrics_T": [ {} ], "sel_metrics_C": [ {} ], "shared": [ 0 ], "shared_all": true } ] } .. _properties-15: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the chart export skip_overwrite,boolean,false,none,Determines whether the existing chart can be skipped. skip_overwrite_probe,boolean,false,none,Determines whether existing dependant probes can be skipped. charts,\ :ref:`[ChartExportTemplate <#tocs_chartexporttemplate>` ],false,none,none AlertImportExportTemplate ------------------------- .. code:: json { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [ 0 ], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } .. _properties-16: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Name of the alert template. NOTE: This property is a mandatory parameter for a POST request. description,string,false,none,Description of the alert template. NOTE: This property is a mandatory parameter for a POST request. reference_id,string,false,none,Internal identifier for the alert template default_history_retention,integer,false,none,Defines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request. object_type,integer,false,none,Defines the type of the object to which this alert template applies. NOTE: This property is a mandatory parameter for a POST request. sql,string,false,none,"SQL query, possibly parameterized, to get a numeric value indicating the threshold reached. NOTE: This property is a mandatory parameter for a POST request." applicable_on_server,string,false,none,"Specifies the type of monitored server to which the template applies. Possible values are ALL, POSTGRES_SERVER, ADVANCED_SERVER. NOTE: This property is a mandatory parameter for a POST request." default_check_frequency,integer,false,none,Specifies how frequently (in minutes) to check for the alert that this template defines. NOTE: This property is a mandatory parameter for a POST request. threshold_unit,string,false,none,"Units used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI." is_system_template,boolean,false,none,Determines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests. is_auto_create,boolean,false,none,Determines whether an alert should be created as soon as an agent or server is added to PEM.. thresholds,[number],false,none,Default threshold values. Values in the thresholds array must be in a sorted order based on the operator. operator,string,false,none,Operator to compare threshold values high_threshold_value,string,false,none,High threshold value medium_threshold_value,string,false,none,Medium threshold value low_threshold_value,string,false,none,Low threshold value info_sql,string,false,none,Defines the SQL query that provides detailed information about the alert on the dashboard. probes,\ :ref:`[CustomProbeImportPostData <#tocs_customprobeimportpostdata>` ],false,none,none .. _enumerated-values-1: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< CustomAlertTemplateExportData ----------------------------- .. code:: json { "alert_templates": [ 0 ] } .. _properties-17: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_templates,[integer],false,none,List of alert template IDs CustomAlertTemplateExportResponseData ------------------------------------- .. code:: json { "version": 1, "alert_templates": [ { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [ 0 ], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } ] } .. _properties-18: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the alert template export alert_templates,\ :ref:`[AlertImportExportTemplate <#tocs_alertimportexporttemplate>` ],false,none,none CustomAlertTemplateImportPostData --------------------------------- .. code:: json { "version": 1, "skip_overwrite": true, "skip_overwrite_probe": true, "alert_templates": [ { "name": "string", "description": "string", "reference_id": "string", "default_history_retention": 0, "object_type": 0, "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "threshold_unit": "string", "is_system_template": true, "is_auto_create": true, "thresholds": [ 0 ], "operator": ">", "high_threshold_value": "string", "medium_threshold_value": "string", "low_threshold_value": "string", "info_sql": "string", "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } ] } .. _properties-19: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the alert template export skip_overwrite,boolean,false,none,Determines whether the existing alert template can be skipped. skip_overwrite_probe,boolean,false,none,Determines whether existing dependent probes can be skipped. alert_templates,\ :ref:`[AlertImportExportTemplate <#tocs_alertimportexporttemplate>` ],false,none,none AlertTemplate ------------- .. code:: json { "name": "string", "description": "string", "object_type": 0, "param_names": [ "string" ], "param_types": "string", "params_units": [ "string" ], "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": [ "string" ], "threshold_unit": "string", "is_system_template": false, "is_auto_create": true, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "info_sql": "string" } .. _properties-20: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Name of the alert template. NOTE: This property is a mandatory parameter for a POST request. description,string,false,none,Description of the alert template. NOTE: This property is a mandatory parameter for a POST request. object_type,integer,false,none,Defines the type of the object to which this alert template applies. NOTE: This property is a mandatory parameter for a POST request. param_names,[string],false,none,Defines the name of parameters. param_types,string,false,none,Defines the type of parameters. Example: INTEGER/STRING.. params_units,[string],false,none,"Defines the unit used for parameters.Example: 'DAYS','True or False','Hours','Minutes' etc" sql,string,false,none,"SQL query, possibly parameterized, to get a numeric value indicating threshold reached. NOTE: This property is a mandatory parameter for a POST request." applicable_on_server,string,false,none,"Specifies the type of monitored server to which the template applies. Possible values are ALL, POSTGRES_SERVER, and ADVANCED_SERVER. NOTE: This property is a mandatory parameter for a POST request." default_check_frequency,integer,false,none,Defines how frequently (in minutes) to check for the alert defined in this template. NOTE: This property is a mandatory parameter for a POST request. default_history_retention,integer,false,none,Defines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request. probe_dependency_list,[string],false,none,Defines the list of probes on which alert template is dependent. threshold_unit,string,false,none,"Units used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI." is_system_template,boolean,false,none,Determines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests. is_auto_create,boolean,false,none,Determines whether an alert should be created as soon as an agent or server is added to PEM.Note: Only supported for Agent and Server level i.e object_type 100 and 200 respectively. operator,string,false,none,Operator to compare threshold values.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. low_threshold_value,number,false,none,Low threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. medium_threshold_value,number,false,none,Medium threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. high_threshold_value,number,false,none,High threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. info_sql,string,false,none,Specifies the SQL query that provides detailed information about the alert on the dashboard. .. _enumerated-values-2: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< AlertTemplatePost ----------------- .. code:: json { "name": "string", "description": "string", "object_type": 0, "params": [ { "param_types": "STRING", "param_units": "KK", "param_names": "param_1" } ], "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": [ { "internal_name": "probe_name" } ], "threshold_unit": "string", "is_system_template": false, "is_auto_create": true, "operator": ">", "low_threshold_value": 0, "medium_threshold_value": 0, "high_threshold_value": 0, "info_sql": "string" } .. _properties-21: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Name of the alert template. NOTE: This property is a mandatory parameter for a POST request. description,string,false,none,Description of the alert template. NOTE: This property is a mandatory parameter for a POST request. object_type,integer,false,none,Defines the type of the object to which this alert template applies. NOTE: This property is a mandatory parameter for a POST request. params,\ :ref:`[AlertTemplateParams <#tocs_alerttemplateparams>` ],false,none,List of parameter/value pairs to be used by the alert template for checking alerts. NOTE: The alert template requires the all parameter to be defined. sql,string,false,none,"SQL query, possibly parameterized, to get a numeric value indicating threshold reached. NOTE: This property is a mandatory parameter for a POST request." applicable_on_server,string,false,none,"Specifies the type of monitored server to which the template applies. Possible values are ALL, POSTGRES_SERVER, and ADVANCED_SERVER. NOTE: This property is a mandatory parameter for a POST request." default_check_frequency,integer,false,none,Defines how frequently (in minutes) to check for the alert defined in this template. NOTE: This property is a mandatory parameter for a POST request. default_history_retention,integer,false,none,Defines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request. probe_dependency_list,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,Defines the list of probes on which alert template is dependent. threshold_unit,string,false,none,"Units used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI." is_system_template,boolean,false,none,Determines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests. is_auto_create,boolean,false,none,Determines whether an alert should be created as soon as an agent or server is added to PEM.Note: Only supported for Agent and Server level i.e object_type 100 and 200 respectively. operator,string,false,none,Operator to compare threshold values.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. low_threshold_value,number,false,none,Low threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. medium_threshold_value,number,false,none,Medium threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. high_threshold_value,number,false,none,High threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively. info_sql,string,false,none,Specifies the SQL query that provides detailed information about the alert on the dashboard. .. _enumerated-values-3: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER operator,> operator,< AlertTemplatePut ---------------- .. code:: json { "name": "string", "description": "string", "sql": "string", "applicable_on_server": "ALL", "default_check_frequency": 0, "default_history_retention": 0, "probe_dependency_list": { "deleted": [ { "internal_name": "probe_name" } ], "added": [ { "internal_name": "probe_name" } ] }, "threshold_unit": "string", "is_system_template": false, "info_sql": "string" } .. _properties-22: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Name of the alert template. NOTE: This property is a mandatory parameter for a POST request. description,string,false,none,Description of the alert template. NOTE: This property is a mandatory parameter for a POST request. sql,string,false,none,"SQL query, possibly parameterized, to get a numeric value indicating threshold reached. NOTE: This property is a mandatory parameter for a POST request." applicable_on_server,string,false,none,"Specifies the type of monitored server to which the template applies. Possible values are ALL, POSTGRES_SERVER, and ADVANCED_SERVER. NOTE: This property is a mandatory parameter for a POST request." default_check_frequency,integer,false,none,Defines how frequently (in minutes) to check for the alert defined in this template. NOTE: This property is a mandatory parameter for a POST request. default_history_retention,integer,false,none,Defines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request. probe_dependency_list,object,false,none,Defines the list of probes on which alert template is dependent. » deleted,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,List of parameter/value pairs to be deleted. » added,\ :ref:`[ProbeDependencyParams <#tocs_probedependencyparams>` ],false,none,List of parameter/value pairs to be added. threshold_unit,string,false,none,"Units used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI." is_system_template,boolean,false,none,Determines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests. info_sql,string,false,none,Specifies the SQL query that provides detailed information about the alert on the dashboard. .. _enumerated-values-4: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable applicable_on_server,ALL applicable_on_server,POSTGRES_SERVER applicable_on_server,ADVANCED_SERVER AlertHistory ------------ .. code:: json { "alert_id": 0, "state": "High", "value": "string", "actual_value": 0 } .. _properties-23: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_id,integer,false,none,Alert ID state,string,false,none,State value,string,false,none,User-presentable value actual_value,number,false,none,Actual value at the time of state change .. _enumerated-values-5: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable state,High state,Medium state,Low ServerStatus ------------ .. code:: json { "id": 0, "name": "string", "group_id": 0, "group_name": "string", "blackout": true, "status": "UP", "alerts": { "total": 0, "acknowledged": 0, "high": 0, "medium": 0, "low": 0, "high_acknowledged": 0, "medium_acknowledged": 0, "low_acknowledged": 0 }, "version": "string", "number_connections": 0, "remote_monitoring": true, "agent_id": 0, "sessions": { "last_recorded_time": 0, "sessions": [ { "database_name": "string", "procpid": 0, "usename": "string", "backend_start": 0, "xact_start": 0, "query_start": 0, "is_waiting": true, "is_idle": true, "is_idle_in_transaction": true, "is_vacuum": true, "is_autovacuum": true, "client_addr": "string", "client_port": 0, "memory_usage_mb": 0, "swap_usage_mb": 0, "cpu_usage": 0, "io_read_bytes": 0, "io_write_bytes": 0, "state": "string", "state_change": 0 } ] } } .. _properties-24: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Server ID name,string,false,none,Server name group_id,integer,false,none,Group ID under which database server is visible to the user group_name,string,false,none,Group name blackout,boolean,false,none,Status of the alert blackout for the database server status,string,false,none,"Server status can be UP, DOWN, UNKNOWN, or UNMANAGED," alerts,object,false,none,"List of alerts configured for the database server, including alert status and number of alerts that are acknowledged" » total,integer,false,none,Number of alerts configured for the database server » acknowledged,integer,false,none,Number of acknowledged alerts » high,integer,false,none,Number of alerts with state as 'High' » medium,integer,false,none,Number of alerts with state as 'Medium' » low,integer,false,none,Number of alerts with state as 'Low' » high_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'High' » medium_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'Medium' » low_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'Low' version,string,false,none,Current version of the database server number_connections,integer,false,none,Number of connections on the database servers remote_monitoring,boolean,false,none,Determines whether the database server is being monitored remotely by the pemAgent agent_id,integer,false,none,Agent ID that is monitoring the database server sessions,object,false,none,All the session information for database servers » last_recorded_time,number,false,none,Unix time of the last recorded time for session information » sessions,[object],false,none,List of all the session information for the database server »» database_name,string,false,none,Database name »» procpid,integer,false,none,Process ID »» usename,string,false,none,User name »» backend_start,number,false,none,Unix time for the session start time »» xact_start,number,false,none,Unix time for the transaction start time »» query_start,number,false,none,Unix time for the query start time (if any queries are running) »» is_waiting,boolean,false,none,Is the sesion waiting? »» is_idle,boolean,false,none,Is the session idle? »» is_idle_in_transaction,boolean,false,none,Is the session idle in a transaction? »» is_vacuum,boolean,false,none,Is this a VACUUM session? »» is_autovacuum,boolean,false,none,Is this an AUTO VACUUM session? »» client_addr,string,false,none,Host address for the client of the session »» client_port,integer,false,none,Client port for the session »» memory_usage_mb,number,false,none,Memory usage (in MB) of the session (available only when monitored locally) »» swap_usage_mb,number,false,none,Swap memory usage (in MB) of the session (available only when monitored locally) »» cpu_usage,number,false,none,CPU Usage (in percentage) of the session (available only when monitored locally) »» io_read_bytes,number,false,none,I/O Read (in bytes) of the session (available only when monitored locally) »» io_write_bytes,number,false,none,I/O Write (in bytes) of the session (available only when monitored locally) »» state,string,false,none,"Current state of the session (idle, active, idle in transcation, and so forth)" »» state_change,number,false,none,Unix time of the last state change in the session .. _enumerated-values-6: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable status,UP status,DOWN status,UNKNOWN status,UNMANAGED AgentStatus ----------- .. code:: json { "id": 0, "name": "string", "group_id": 0, "group_name": "string", "blackout": true, "status": "UP", "alerts": { "total": 0, "acknowledged": 0, "high": 0, "medium": 0, "low": 0, "high_acknowledged": 0, "medium_acknowledged": 0, "low_acknowledged": 0 }, "version": "string", "processes": 0, "threads": 0, "cpu_utilization": 0, "memory_utilization": 0, "swap_utilization": 0, "disk_utilization": 0 } .. _properties-25: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Agent ID name,string,false,none,Agent name group_id,integer,false,none,Group ID under which agent is visible to the user group_name,string,false,none,Group name blackout,boolean,false,none,Determines whether an alert blackout for the agent is enabled or disabled. status,string,false,none,"Agent status can be UP, DOWN, or UNKNOWN" alerts,object,false,none,"List of alerts configured for the agent, including alert status and number of alerts that are acknowledged" » total,integer,false,none,Number of alerts configured for the agent » acknowledged,integer,false,none,Number of acknowledged alerts » high,integer,false,none,Number of alerts with state as 'High' » medium,integer,false,none,Number of alerts with state as 'Medium' » low,integer,false,none,Number of alerts with state as 'Low' » high_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'High' » medium_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'Medium' » low_acknowledged,integer,false,none,Number of acknowledged alerts with state as 'Low' version,string,false,none,Current version of the agent processes,integer,false,none,Number of processes running threads,integer,false,none,Number of threads for all the running processes cpu_utilization,number,false,none,CPU utilization (percentage) memory_utilization,number,false,none,Memory utilization (percentage) swap_utilization,number,false,none,Swap memory utilization (percentage) disk_utilization,number,false,none,Overall disk utilization (percentage) .. _enumerated-values-7: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable status,UP status,DOWN status,UNKNOWN AlertStatus ----------- .. code:: json { "alert_since": "string", "alert_id": 0, "alert_name": "string", "alert_state": "High", "value": "string", "object_description": "string", "server_id": 0, "agent_id": 0, "database": "string", "schema": "string", "package": "string", "object": "string", "alert_target_level": "Global", "last_processed": "string", "info": "string", "info_cols": [ "string" ], "info_vals": [ [ "string" ] ] } .. _properties-26: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable alert_since,string,false,none,Unix time when alert state last changed alert_id,integer,false,none,Alert internal identification number alert_name,string,false,none,Name of the alert alert_state,string,false,none,Current state of the alert. A 'null' value suggests alert threshold values have not currently been violated for the alert. value,string,false,none,Current value of the alert object_description,string,false,none,Monitoring object description/name server_id,integer,false,none,null or ID of the server agent_id,integer,false,none,null or ID of the agent database,string,false,none,null or name of the database schema,string,false,none,null or name of the schema/namespace package,string,false,none,null or name of the EDB package object,string,false,none,null or name of any other type of object alert_target_level,string,false,none,Alert target level last_processed,string,false,none,String reprenting Unix time when the alert was processed info,string,false,none,Some information at the time when the alert was generated info_cols,[string],false,none,Array of column names for the information info_vals,[array],false,none,Detailed information associated with the alert in the form of a table (an array of an array) .. _enumerated-values-8: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable alert_state,High alert_state,Medium alert_state,Low alert_target_level,Global alert_target_level,Agent alert_target_level,Server alert_target_level,Database alert_target_level,Schema alert_target_level,Table alert_target_level,Index alert_target_level,Sequence alert_target_level,Function alert_target_level,View CustomProbes ------------ .. code:: json { "probe_id": 0, "probe_name": "string", "enabled": true, "target_type": 0, "internal_name": "string", "is_system_probe": true, "any_server_version": true, "collection_method": "w", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_id": 0, "pc_name": "string", "pc_data_type": "bigint", "pc_internal_name": "string", "pc_unit": "string", "pc_col_type": "m", "pc_position": 0, "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ] } .. _properties-27: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_id,integer,false,none,Identifier for a probe probe_name,string,false,none,Name of the probe enabled,boolean,false,none,Determines whether the probe is enabled or disabled by default. target_type,integer,false,none,Defines the type of the object to which the probe applies. internal_name,string,false,none,"Defines the internal name of the probe. The PEM system creates internal tables for storing probe statistics in the 'pemdata', and 'pemhistory' schema. The names of those tables are the same as the internal name." is_system_probe,boolean,false,none,Determines whether this probe is user-defined. This flag is always false for a user-defined probe. any_server_version,boolean,false,none,"Determines whether this probe applies to any version of a Postgres variant. For more details, please consult the documentation." collection_method,string,false,none,"Defines the method of statistics collection. PEM supports three methods for custom made probes: SQL, WMI, or batch/shell script. " interval,integer,false,none,Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 lifetime,integer,false,none,Defines the history data retention time (in days). Valid range is 1-365. This value does not have any effect if 'discard_history' is set to true. discard_history,boolean,false,none,"Determines whether to discard history data. When 'discard_history' is set to false, history of the data for this probe is not stored." platform,string,false,none,Defines the platform where this probe can run. This value only applies to an agent-level probe. probe_code,string,false,none,A SQL/Batch script/Shell script/WMI script to collect the statistics as per the definition of the code. probe_columns,[object],false,none,none » pc_id,integer,false,none,Column identifier » pc_name,string,false,none,Column name » pc_data_type,string,false,none,Data type of the column. Supported datatypes are: » pc_internal_name,string,false,none,Returns the internal name of the column. » pc_unit,string,false,none,Returns the unit of the column. » pc_col_type,string,false,none,"Returns the column as part of the primary key of the internal table, or not. 'k' stands for a key column, and 'm' stands for a member/normal column." » pc_position,integer,false,none,Returns the position of the column in the internal table. » pc_graphable,boolean,false,none,Determines whether the data of the column can be graphed on a chart. » pc_calc_pit,boolean,false,none,Determines whether the server calculates the point-in-time for metric data for this column. » pc_pit_default,boolean,false,none,Determines whether the metric is stored by point-in-time by default. Please refer to the 'Custom Probes' section in the documentation for detailed information. alternate_code,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,none .. _enumerated-values-9: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable collection_method,w collection_method,b collection_method,s platform,unix platform,windows pc_data_type,bigint pc_data_type,char pc_data_type,decimal pc_data_type,double precision pc_data_type,integer pc_data_type,numeric pc_data_type,real pc_data_type,text pc_data_type,text\[] pc_data_type,timestamp pc_data_type,timestamptz pc_col_type,m pc_col_type,k CustomProbeExportData --------------------- .. code:: json { "probes": [ 0 ] } .. _properties-28: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probes,[integer],false,none,List of the probe IDs for custom probes CustomProbeImportData --------------------- .. code:: json { "version": 1, "skip_overwrite": true, "probes": [ { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } ] } .. _properties-29: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable version,integer,false,none,Version of the probe export skip_overwrite,boolean,false,none,Determines whether existing probes can be skipped. probes,\ :ref:`[CustomProbeImportPostData <#tocs_customprobeimportpostdata>` ],false,none,none CustomProbeImportPostData ------------------------- .. code:: json { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "internal_name": "string" } .. _properties-30: Properties ^^^^^^^^^^ allOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable *anonymous*,:ref:`CustomProbePostData` ,false,none,none and .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable *anonymous*,object,false,none,none » internal_name,string,false,none,Internal name of the probe from the system where probe was exported CustomProbePostData ------------------- .. code:: json { "probe_name": "string", "collection_method": "w", "enabled": true, "target_type": 0, "any_server_version": true, "any_extension_version": true, "extension_name": "string", "interval": 0, "lifetime": 0, "discard_history": true, "platform": "unix", "probe_code": "string", "probe_columns": [ { "pc_name": "string", "pc_data_type": "bigint", "pc_unit": "string", "pc_col_type": "m", "pc_graphable": true, "pc_calc_pit": true, "pc_pit_default": true } ], "alternate_code": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ] } .. _properties-31: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_name,string,false,none,Name of the probe collection_method,string,false,none,"Defines the method of statistics collection. PEM supports three methods for custom made probes: SQL, WMI, or batch/shell script. " enabled,boolean,false,none,Determines whether whether the probe is enabled/disabled by default. target_type,integer,false,none,Defines the type of the object to which the probe applies. any_server_version,boolean,false,none,"Determines whether this probe applies to any version of a Postgres variant. For more details, please consult the documentation." any_extension_version,boolean,false,none,"Determines whether this probe applies to any version of a Extension variant. For more details, please consult the documentation." extension_name,string,false,none,"Name of the extension." interval,integer,false,none,Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 lifetime,integer,false,none,Defines the history data retention time (in days). Valid range is 1-365. This value does not have any effect if 'discard_history' is set to true. discard_history,boolean,false,none,"Defines whether to discard history data. When 'discard_history' is set to false, no history data is stored for this probe." platform,string,false,none,Defines the platform where this probe can run. This value only applies to an agent-level probe. probe_code,string,false,none,A SQL/Batch script/Shell script/WMI script to collect the statistics as per definition of the code. probe_columns,[object],false,none,none » pc_name,string,false,none,Column name » pc_data_type,string,false,none,Data type of the column. Supported datatypes are: » pc_unit,string,false,none,Returns the unit of the column. » pc_col_type,string,false,none,"Returns the columns as part of the primary key of the internal table, or not. 'k' stands for a key column, and 'm' stands for a member/normal column." » pc_graphable,boolean,false,none,Determines whether the data of the column can be graphed on a chart. » pc_calc_pit,boolean,false,none,Determines whether the server calculates point-in-time for metric data for this column. » pc_pit_default,boolean,false,none,Determines whether metric data is stored by point-in-time by default. Please refer to the 'Custom Probes' section in the documentation for detailed information. alternate_code,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,none .. _enumerated-values-10: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable collection_method,w collection_method,b collection_method,s platform,unix platform,windows pc_data_type,bigint pc_data_type,char pc_data_type,decimal pc_data_type,double precision pc_data_type,integer pc_data_type,numeric pc_data_type,real pc_data_type,text pc_data_type,text\[] pc_data_type,timestamp pc_data_type,timestamptz pc_col_type,m pc_col_type,k CustomProbePutData ------------------ .. code:: json { "interval_min": 0, "interval_sec": 0, "lifetime": 0, "enabled": true, "probe_code": "string", "probe_columns": { "changed": [ { "pc_id": 0, "pc_unit": "string", "pc_graphable": true } ] }, "alternate_code": { "changed": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ], "deleted": [ { "server_version_id": 0 } ], "added": [ { "server_version_id": 0, "server_probe_code": "string", "extension_version": 0 } ] } } .. _properties-32: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable interval_min,integer,false,none,Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. interval_sec,integer,false,none,Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. lifetime,integer,false,none,Defines the history data retention time (in days). Valid range is 1-365. This value does not have any effect if 'discard_history' is set to true. enabled,boolean,false,none,Determines whether the probe is enabled by default. probe_code,string,false,none,A SQL/Batch script/Shell script/WMI script to collect the statistics as per definition of the code. probe_columns,object,false,none,none » changed,\ :ref:`[ProbeColumn <#tocs_probecolumn>` ],false,none,List of the changed probe column alternate_code,object,false,none,none » changed,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,List of the changed alternate probe code for some server version » deleted,\ :ref:`[DeletedAlternateServerProbeCode <#tocs_deletedalternateserverprobecode>` ],false,none,List of the deleted alternate probe code for some server versions » added,\ :ref:`[AlternateServerProbeCode <#tocs_alternateserverprobecode>` ],false,none,List of the alternate probe code added for some server versions Probes ------ .. code:: json { "probe_id": 0, "probe_name": "string", "default_interval_min": 0, "interval_min": 0, "default_interval_sec": 0, "interval_sec": 0, "default_interval": 0, "interval": 0, "default_lifetime": 0, "lifetime": 0, "default_enabled": true, "enabled": true, "target_type_id_returned": 0 } .. _properties-33: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable probe_id,integer,false,none,Unique ID of the probe probe_name,string,false,none,Name of the probe default_interval_min,integer,false,none,Defines the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. interval_min,integer,false,none,Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. default_interval_sec,integer,false,none,Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. interval_sec,integer,false,none,Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. default_interval,integer,false,none,Defines the default interval for the probe to collect statistics (in seconds). interval,integer,false,none,Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 default_lifetime,integer,false,none,Defines the default history data retention time (in days). lifetime,integer,false,none,Defines the history data retention time (in days). Valid range is 1-365. This value does not have any effect if 'discard_history' is set to true. default_enabled,boolean,false,none,Defines the default probe enabled/disabled value. enabled,boolean,false,none,Specifies whether whether the probe is enabled/disabled by default. target_type_id_returned,integer,false,none,Defines the return target type value. ProbeConfigData --------------- .. code:: json { "interval_min": 0, "interval_sec": 0, "lifetime": 0, "enabled": true } .. _properties-34: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable interval_min,integer,false,none,"Probe execution frequency (in minutes). The allowed interval value (in minutes) is 0-2880. NOTE: The total interval must be greater than 10 seconds. That is, 10 >= interval_min \* 60 + interval_sec >= 172800." interval_sec,integer,false,none,"Probe execution frequency (in seconds). The allowed interval value (in seconds) is 0-59. NOTE: Total interval must be greater than 10 seconds. That is, 10 >= interval_min \* 60 + interval_sec >= 172800." lifetime,integer,false,none,"Probe history data retention period (in days). That is, 1 <= lifetime <= 365." enabled,boolean,false,none,Determines whether the probe is enabled for the given object. CopyAgentData ------------- .. code:: json { "type": "string", "agent_id": 0 } .. _properties-35: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""agent""" agent_id,integer,false,none,none CopyServerData -------------- .. code:: json { "type": "string", "server_id": 0 } .. _properties-36: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""server""" server_id,integer,false,none,none CopyDatabaseData ---------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string" } .. _properties-37: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""database""" server_id,integer,false,none,none database_name,string,false,none,none CopySchemaData -------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string" } .. _properties-38: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""schema""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none CopyAlertAgentData ------------------ .. code:: json { "type": "string", "agent_id": 0, "existing_alert_options": "I" } .. _properties-39: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""agent""" agent_id,integer,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-11: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertServerData ------------------- .. code:: json { "type": "string", "server_id": 0, "existing_alert_options": "I" } .. _properties-40: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""server""" server_id,integer,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-12: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertDatabaseData --------------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "existing_alert_options": "I" } .. _properties-41: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""database""" server_id,integer,false,none,none database_name,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-13: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertSchemaData ------------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string", "existing_alert_options": "I" } .. _properties-42: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""schema""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-14: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertTableData ------------------ .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string", "table_name": "string", "existing_alert_options": "I" } .. _properties-43: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""table""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none table_name,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-15: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertIndexData ------------------ .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string", "index_name": "string", "existing_alert_options": "I" } .. _properties-44: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""index""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none index_name,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-16: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertFunctionData --------------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string", "function_name": "string", "function_arguments": "string", "existing_alert_options": "I" } .. _properties-45: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""function""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none function_name,string,false,none,none function_arguments,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-17: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D CopyAlertSequenceData --------------------- .. code:: json { "type": "string", "server_id": 0, "database_name": "string", "schema_name": "string", "sequence_name": "string", "existing_alert_options": "I" } .. _properties-46: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable type,string,false,none,"Value must be ""sequence""" server_id,integer,false,none,none database_name,string,false,none,none schema_name,string,false,none,none sequence_name,string,false,none,none existing_alert_options,string,false,none,Determines whether to ignore/Replace the duplicate alerts to be copied or to Delete all the existing alerts from target. Supported valid values are: I -> Ignore Duplicates R -> Replace Duplicates D -> Delete Existing Alerts .. _enumerated-values-18: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable existing_alert_options,I existing_alert_options,R existing_alert_options,D Agent ----- .. code:: json { "id": 0, "name": "string", "version": "string", "active": true, "heartbeat_tolerance": 0, "alert_blackout": true, "owner": "string", "team": "string", "gid": 0, "tags": [ "string" ], "ignore_mnt_points": [ "string" ] } Returns the list of objects, which contains agent information, version, capabilities, and details about the host on which the agent has been installed. **For example:** \\ .. code:: json [{ /* Agent information */ "id": 1, "gid": 0, "name": "Postgres Enterprise Manager Host" "version": "9.3.0", "active": True, "heartbeat_tolerance": 15, "alert_blackout": False, "owner": "postgres", "team": None, /* Deatils about the Host, on which it is installed */ "operating_sys": "Ubuntu 12.04.5 LTS", "host_name": "edb-ubuntu", "boot_time": "2016-09-19 12:28:27+05:30", "domain_name": "(none)", "window_domain": None, /* Agent capabilities */ "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart", /* Monitored servers */ "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12" }] a .. _properties-47: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Identity of the pem-agent name,string,false,none,Description (name) of the agent. version,string,false,none,Version of the pem-agent active,boolean,false,none,Determines whether the agent is active. An active agent is responsible for collecting the statistics for the host and the monitored server. heartbeat_tolerance,integer,false,none,heartbeat tolerance (in seconds) for the agent. Specifies how late a heartbeat can be before it is considered missed. alert_blackout,boolean,false,none,Determines whether the alert is blacked out for the agent. owner,string,false,none,Username of user who installed the agent. This user is called the owner. team,string,false,none,Name of the role/user who can see this agent. A null/empty value indicates all users can see this agent. gid,integer,false,none,Identity of the group tags,[string],false,none,List of tags associated with the agent ignore_mnt_points,[string],false,none,Used to ignore the mount point for disk usage calculation Agents ------ .. code:: json [ { "id": 0, "name": "string", "version": "string", "active": true, "heartbeat_tolerance": 0, "alert_blackout": true, "owner": "string", "team": "string", "gid": 0, "tags": [ "string" ], "ignore_mnt_points": [ "string" ] } ] Returns the list of objects, which contains agent information, version, capabilities, and details about the host on which the agent has been installed. **For example:** \\ .. code:: json [{ /* Agent information */ "id": 1, "gid": 0, "name": "Postgres Enterprise Manager Host" "version": "9.3.0", "active": True, "heartbeat_tolerance": 15, "alert_blackout": False, "owner": "postgres", "team": None, /* Deatils about the Host, on which it is installed */ "operating_sys": "Ubuntu 12.04.5 LTS", "host_name": "edb-ubuntu", "boot_time": "2016-09-19 12:28:27+05:30", "domain_name": "(none)", "window_domain": None, /* Agent capabilities */ "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart", /* Monitored servers */ "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12" }] a .. _properties-48: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,true,none,Identity of the pem-agent name,string,true,none,Description (name) of the agent. version,string,true,none,Version of the pem-agent active,boolean,true,none,Determines whether the agent is active. An active agent is responsible for collecting the statistics for the host and the monitored server. heartbeat_tolerance,integer,true,none,heartbeat tolerance (in seconds) for the agent. Specifies how late a heartbeat can be before it is considered missed. alert_blackout,boolean,true,none,Determines whether the alert is blacked out for the agent. owner,string,true,none,Username of user who installed the agent. This user is called the owner. team,string,true,none,Name of the role/user who can see this agent. A null/empty value indicates all users can see this agent. gid,integer,false,none,Identity of the group tags,[string],false,none,List of tags associated with the agent ignore_mnt_points,[string],false,none,Used to ignore the mount point for disk usage calculation Server ------ .. code:: json { "id": 0, "name": "string", "host": "string", "port": 0, "db": "string", "serviceid": "string", "connection_params": [ { "name": "string", "keyword": "string", "value": null } ], "active": true, "alert_blackout": true, "owner": 0, "team": "string", "server_owner": "string", "is_remote_monitoring": true, "tags": [ "string" ], "replication_solution": "none", "efm_cluster_name": "string", "efm_service_name": "string", "efm_installation_path": "string", "patroni_cluster_name": "string", "patroni_installation_path": "string", "patroni_config_path": "string", "comment": "string", "username": "string", "gid": 0, "server_group_name": "string", "db_res": "string", "role": "string", "is_edb": true, "agent_id": 0, "asb_host": "string", "asb_port": 0, "asb_username": "string", "asb_database": "string", "asb_sslmode": "prefer", "agent_allowtakeover": false, "agent_capability_list": [ "string" ], "agent_description": "string", "sslcompression": false, "use_ssh_tunnel": false, "tunnel_host": "string", "tunnel_port": 22, "tunnel_username": "string", "tunnel_authentication": false, "tunnel_identity_file": "string", "post_connection_sql": "string" } .. _properties-49: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Server ID.NOTE: This property is not applicable for a POST request. name,string,false,none,Server name host,string,false,none,Server host port,integer,false,none,Server port db,string,false,none,Maintenance databse serviceid,string,false,none,Server service ID connection_params,[object],false,none,List of connection parameters for the server. » name,string,false,none,Parameter name » keyword,string,false,none,Parameter keyword » value,any,false,none,Parameter value active,boolean,false,none,Determines whether the server is active. alert_blackout,boolean,false,none,Determines whether the alerts on the server are blacked out. owner,integer,false,none,ID of the owner who registered the server with PEM. team,string,false,none,Defines the role/username who can see server information. server_owner,string,false,none,Name of the user who registered the server on the PEM database server. is_remote_monitoring,boolean,false,none,"Determines whether this server is being monitored remotely (that is, the monitoring pemAgent does not reside on the same host as the monitored server)." tags,[string],false,none,List of tags associated with the server. replication_solution,string,false,none,Replication solution used by the server efm_cluster_name,string,false,none,Cluster name of EFM efm_service_name,string,false,none,Service name of EFM efm_installation_path,string,false,none,Installation path of EFM patroni_cluster_name,string,false,none,Cluster name of Patroni patroni_installation_path,string,false,none,Installation path of Patroni patroni_config_path,string,false,none,Configuration path of Patroni comment,string,false,none,Description of the server username,string,false,none,Username for connecting the database server gid,integer,false,none,ID of the server group server_group_name,string,false,none,Name of the server group db_res,string,false,none,Database restriction SQL clause role,string,false,none,The role the connection will use is_edb,boolean,false,none,Is server an EDB Advanced Server? agent_id,integer,false,none,Agent ID bound to the server asb_host,string,false,none,PEM database host used by agent while creating PEM connection asb_port,integer,false,none,PEM database port used by agent while creating PEM connection asb_username,string,false,none,PEM database user name used by agent while creating PEM connection asb_database,string,false,none,PEM database to which agent will connect asb_sslmode,string,false,none,PEM database SSL mode agent_allowtakeover,boolean,false,none,Specifies whether the server can be taken over by another agent. agent_capability_list,[string],false,none,Array of agent capabilities agent_description,string,false,none,Agent description sslcompression,boolean,false,none,Determines whether data sent over SSL should be compressed. use_ssh_tunnel,boolean,false,none,Determines whether to use ssh tunnel. tunnel_host,string,false,none,Tunnel host name tunnel_port,integer,false,none,Tunnel port number tunnel_username,string,false,none,Tunnel username tunnel_authentication,boolean,false,none,Determines whether to use tunnel authentication. tunnel_identity_file,string,false,none,Tunnel identity file used for authentication. post_connection_sql,string,false,none,SQL to be executed after establishing the connection. .. _enumerated-values-19: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable replication_solution,none replication_solution,efm replication_solution,patroni asb_sslmode,prefer asb_sslmode,allow asb_sslmode,disable asb_sslmode,require asb_sslmode,verify-ca asb_sslmode,verify-full ServerGroupBody --------------- .. code:: json { "name": "string" } .. _properties-50: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Server group name ServerGroupBodyGet ------------------ .. code:: json { "id": 0, "name": "string", "hidden": true, "parent_id": 0 } .. _properties-51: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Server group id name,string,false,none,Server group name hidden,boolean,false,none,Determines whether Server group is hidden parent_id,integer,false,none,Parent server group id. Note: Cluster type node will have parent id else it will be null. ServerBody ---------- .. code:: json { "name": "string", "host": "string", "port": 0, "db": "string", "serviceid": "string", "connection_params": [ { "name": "sslmode", "keyword": "sslmode", "value": "prefer" }, { "name": "connect_timeout", "keyword": "connect_timeout", "value": 10 } ], "alert_blackout": true, "team": "string", "is_remote_monitoring": true, "tags": [ { "text": "tag1", "color": "#8789AC" }, { "text": "tag2", "color": "#0C767A" } ], "replication_solution": "none", "efm_cluster_name": "string", "efm_service_name": "string", "efm_installation_path": "string", "patroni_cluster_name": "string", "patroni_installation_path": "string", "patroni_config_path": "string", "comment": "string", "username": "string", "gid": 0, "hostaddr": "string", "db_res": "string", "role": "string", "agent_id": 0, "asb_host": "string", "asb_port": 0, "asb_username": "string", "asb_database": "string", "asb_sslmode": "prefer", "asb_password": "string", "agent_allowtakeover": false, "fgcolor": "#000000", "bgcolor": "#FFFFFF", "sslcompression": false, "use_ssh_tunnel": false, "tunnel_host": "string", "tunnel_port": 22, "tunnel_username": "string", "tunnel_password": "string", "tunnel_authentication": false, "tunnel_identity_file": "string", "post_connection_sql": "string" } .. _properties-52: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Server name host,string,false,none,Server host name or address port,integer,false,none,Server port db,string,false,none,Maintenance databse serviceid,string,false,none,Server service ID connection_params,[object],false,none,List of connection parameters for the server. » name,string,false,none,Parameter name » keyword,string,false,none,Parameter keyword » value,any,false,none,Parameter value alert_blackout,boolean,false,none,Determines whether the alerts on the server are blacked out. team,string,false,none,Defines the role/username who can see server information. is_remote_monitoring,boolean,false,none,"Determines whether this server is being monitored remotely (that is, the monitoring pemAgent does not reside on the same host as the monitored server)." tags,[object],false,none,List of tags associated with the server. » text,string,false,none,The name of the tag. » color,string,false,none,The color associated with the tag. replication_solution,string,false,none,Replication solution used by the server efm_cluster_name,string,false,none,Cluster name of EFM efm_service_name,string,false,none,Service name of EFM efm_installation_path,string,false,none,Installation path of EFM patroni_cluster_name,string,false,none,Cluster name of Patroni patroni_installation_path,string,false,none,Installation path of Patroni patroni_config_path,string,false,none,Configuration path of Patroni comment,string,false,none,Description of the server username,string,false,none,Username for connecting the database server gid,integer,false,none,ID of the server group hostaddr,string,false,none,Server host address db_res,string,false,none,Database restriction SQL clause role,string,false,none,The role the connection will use agent_id,integer,false,none,Agent ID bound to the server asb_host,string,false,none,PEM database host used by agent while creating PEM connection asb_port,integer,false,none,PEM database port used by agent while creating PEM connection asb_username,string,false,none,PEM database user name used by agent while creating PEM connection asb_database,string,false,none,PEM database to which agent will connect asb_sslmode,string,false,none,PEM database SSL mode asb_password,string,false,none,empty string agent_allowtakeover,boolean,false,none,Specifies whether the server can be taken over by another agent. fgcolor,string,false,none,Foreground color of server node in browser tree. Default is black( #000000) bgcolor,string,false,none,Background color of server node in browser tree. Default is white( #FFFFFF) sslcompression,boolean,false,none,Determines whether data sent over SSL should be compressed. use_ssh_tunnel,boolean,false,none,Determines whether to use ssh tunnel. tunnel_host,string,false,none,Tunnel host name tunnel_port,integer,false,none,Tunnel port number tunnel_username,string,false,none,Tunnel username tunnel_password,string,false,none,Tunnel password tunnel_authentication,boolean,false,none,Determines whether to use tunnel authentication. tunnel_identity_file,string,false,none,Tunnel identity file used for authentication. post_connection_sql,string,false,none,SQL to be executed after establishing the connection. .. _enumerated-values-20: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable replication_solution,none replication_solution,efm replication_solution,patroni asb_sslmode,prefer asb_sslmode,allow asb_sslmode,disable asb_sslmode,require asb_sslmode,verify-ca asb_sslmode,verify-full ServerBodyUpdate ---------------- .. code:: json { "name": "string", "host": "string", "port": 0, "db": "string", "serviceid": "string", "connection_params": { "added": [ { "keyword": "hostaddr", "name": "hostaddr", "value": "qwde" } ], "changed": [ { "keyword": "connect_timeout", "name": "connect_timeout", "value": "20" } ], "deleted": [ { "keyword": "sslmode", "name": "sslmode", "value": "prefer" } ] }, "alert_blackout": true, "team": "string", "is_remote_monitoring": true, "tags": { "added": [ { "color": "#0C767A", "text": "tag4" } ], "deleted": [ { "text": "tag1", "color": "#8789AC", "old_text": "tag2" } ], "changed": [ { "old_text": "tag", "text": "tag3" } ] }, "replication_solution": "none", "efm_cluster_name": "string", "efm_service_name": "string", "efm_installation_path": "string", "patroni_cluster_name": "string", "patroni_installation_path": "string", "patroni_config_path": "string", "comment": "string", "username": "string", "gid": 0, "hostaddr": "string", "db_res": "string", "role": "string", "agent_id": 0, "asb_host": "string", "asb_port": 0, "asb_username": "string", "asb_database": "string", "asb_sslmode": "prefer", "asb_password": "string", "agent_allowtakeover": false, "fgcolor": "#000000", "bgcolor": "#FFFFFF", "sslcompression": false, "use_ssh_tunnel": false, "tunnel_host": "string", "tunnel_port": 22, "tunnel_username": "string", "tunnel_password": "string", "tunnel_authentication": false, "tunnel_identity_file": "string", "post_connection_sql": "string" } .. _properties-53: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Server name host,string,false,none,Server host name or address port,integer,false,none,Server port db,string,false,none,Maintenance databse serviceid,string,false,none,Server service ID connection_params,[object],false,none,List of connection parameters for the server. » name,string,false,none,Parameter name » keyword,string,false,none,Parameter keyword » value,any,false,none,Parameter value alert_blackout,boolean,false,none,Determines whether the alerts on the server are blacked out. team,string,false,none,Defines the role/username who can see server information. is_remote_monitoring,boolean,false,none,"Determines whether this server is being monitored remotely (that is, the monitoring pemAgent does not reside on the same host as the monitored server)." tags,[object],false,none,List of tags associated with the server. » text,string,true,none,The name of the tag. » color,string,true,none,The color associated with the tag. » old_text,string¦null,false,none,The previous name of the tag (used for tracking changes). replication_solution,string,false,none,Replication solution used by the server efm_cluster_name,string,false,none,Cluster name of EFM efm_service_name,string,false,none,Service name of EFM efm_installation_path,string,false,none,Installation path of EFM patroni_cluster_name,string,false,none,Cluster name of Patroni patroni_installation_path,string,false,none,Installation path of Patroni patroni_config_path,string,false,none,Configuration path of Patroni comment,string,false,none,Description of the server username,string,false,none,Username for connecting the database server gid,integer,false,none,ID of the server group hostaddr,string,false,none,Server host address db_res,string,false,none,Database restriction SQL clause role,string,false,none,The role the connection will use agent_id,integer,false,none,Agent ID bound to the server asb_host,string,false,none,PEM database host used by agent while creating PEM connection asb_port,integer,false,none,PEM database port used by agent while creating PEM connection asb_username,string,false,none,PEM database user name used by agent while creating PEM connection asb_database,string,false,none,PEM database to which agent will connect asb_sslmode,string,false,none,PEM database SSL mode asb_password,string,false,none,empty string agent_allowtakeover,boolean,false,none,Specifies whether the server can be taken over by another agent. fgcolor,string,false,none,Foreground color of server node in browser tree. Default is black( #000000) bgcolor,string,false,none,Background color of server node in browser tree. Default is white( #FFFFFF) sslcompression,boolean,false,none,Determines whether data sent over SSL should be compressed. use_ssh_tunnel,boolean,false,none,Determines whether to use ssh tunnel. tunnel_host,string,false,none,Tunnel host name tunnel_port,integer,false,none,Tunnel port number tunnel_username,string,false,none,Tunnel username tunnel_password,string,false,none,Tunnel password tunnel_authentication,boolean,false,none,Determines whether to use tunnel authentication. tunnel_identity_file,string,false,none,Tunnel identity file used for authentication. post_connection_sql,string,false,none,SQL to be executed after establishing the connection. .. _enumerated-values-21: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable replication_solution,none replication_solution,efm replication_solution,patroni asb_sslmode,prefer asb_sslmode,allow asb_sslmode,disable asb_sslmode,require asb_sslmode,verify-ca asb_sslmode,verify-full AgentBody --------- .. code:: json { "name": "string", "heartbeat_tolerance": 0, "alert_blackout": true, "team": "string", "gid": 0, "tags": { "added": [ { "color": "#0C767A", "text": "tag4" } ], "deleted": [ { "text": "tag1", "color": "#8789AC", "old_text": "tag2" } ], "changed": [ { "old_text": "tag", "text": "tag3" } ] }, "ignore_mnt_points": [ "string" ] } Returns the list of objects, which contains agent information, version, capabilities, and details about the host on which the agent has been installed. **For example:** \\ .. code:: json [{ /* Agent information */ "id": 1, "gid": 0, "name": "Postgres Enterprise Manager Host" "version": "9.3.0", "active": True, "heartbeat_tolerance": 15, "alert_blackout": False, "owner": "postgres", "team": None, /* Deatils about the Host, on which it is installed */ "operating_sys": "Ubuntu 12.04.5 LTS", "host_name": "edb-ubuntu", "boot_time": "2016-09-19 12:28:27+05:30", "domain_name": "(none)", "window_domain": None, /* Agent capabilities */ "capability_list": "unix, getloadavg, disk_space, memory_usage, cpu_usage, network_statistics, io_analysis, data_log_file_analysis, disk_busy_info, os_statistics, os_info, slony_replication, auto_discover_servers, allow_server_restart", /* Monitored servers */ "server_bind": "Postgres Enterprise Manager Server, PostgreSQL 11, PostgreSQL 12" }] a .. _properties-54: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Description (name) of the agent. heartbeat_tolerance,integer,false,none,heartbeat tolerance (in seconds) for the agent. Specifies how late a heartbeat can be before it is considered missed. alert_blackout,boolean,false,none,Determines whether the alert is blacked out for the agent. team,string,false,none,Name of the role/user who can see this agent. A null/empty value indicates all users can see this agent. gid,integer,false,none,Identity of the group tags,[object],false,none,List of tags associated with the agent. » text,string,true,none,The name of the tag. » color,string,true,none,The color associated with the tag. » old_text,string¦null,false,none,The previous name of the tag (used for tracking changes). ignore_mnt_points,[string],false,none,Used to ignore the mount point for disk usage calculation AgentJobBodyGet --------------- .. code:: json { "jobname": "string", "jobenabled": true, "jobdesc": "string" } .. _properties-55: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable jobname,string,false,none,Name of the job. jobenabled,boolean,false,none,Determines whether the job is enabled or disabled. jobdesc,string,false,none,Description of the job. AgentJobBody ------------ .. code:: json { "jobid": 0, "jobname": "string", "jobenabled": true, "jobdesc": "string", "jobcreated": "2019-08-24T14:15:22Z", "jobchanged": "2019-08-24T14:15:22Z", "jlgstatus": "string", "jobnextrun": "2019-08-24T14:15:22Z", "joblastrun": "2019-08-24T14:15:22Z", "is_alert_job": true, "notify": "string", "email_group_id": "string", "jsteps": [], "jschedules": [ { "jscid": 0, "jscjobid": 0, "jscname": "string", "jscdesc": "string", "jscenabled": true, "jscstart": "2019-08-24T14:15:22Z", "jscend": "2019-08-24T14:15:22Z", "jscweekdays": [ true ], "jscmonthdays": [ true ], "jscmonths": [ true ], "jschours": [ true ], "jscminutes": [ true ], "jscexceptions": [ null ], "jsctimezone": "string" } ] } .. _properties-56: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable jobid,integer,false,none,ID of the job. jobname,string,false,none,Name of the job. jobenabled,boolean,false,none,Determines whether the job is enabled or disabled. jobdesc,string,false,none,Description of the job. jobcreated,string(date-time),false,none,Timestamp when the job was created. jobchanged,string(date-time),false,none,Timestamp when the job was last modified. jlgstatus,string,false,none,Status of the last job execution. jobnextrun,string(date-time)¦null,false,none,Timestamp of the next scheduled run. joblastrun,string(date-time)¦null,false,none,Timestamp of the last run. is_alert_job,boolean,false,none,Indicates if the job is an alert job. notify,string,false,none,Notification setting for the job. email_group_id,string,false,none,ID of the email group for notifications. jsteps,[object],false,none,List of steps for the job. » jstid,integer,false,none,ID of the step. » jstjobid,integer,false,none,ID of the job associated with the step. » jstname,string,false,none,Name of the step. » jstdesc,string,false,none,Description of the step. » jstenabled,boolean,false,none,Determines whether the step is enabled or disabled. » jstkind,boolean,false,none,"Determines the kind of the step. True for SQL step, False for Batch step." » jstcode,string,false,none,Code or script for the step. » server_id,integer,false,none,ID of the server associated with the step. » database_name,string,false,none,Name of the database associated with the step. » jstonerror,string,false,none,"Specifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore')." jschedules,[object],false,none,List of schedules for the job. » jscid,integer¦null,false,none,ID of the schedule. » jscjobid,integer¦null,false,none,ID of the job associated with the schedule. » jscname,string,false,none,Name of the schedule. » jscdesc,string,false,none,Description of the schedule. » jscenabled,boolean,false,none,Determines whether the schedule is enabled or disabled. » jscstart,string(date-time),false,none,Start date and time of the schedule. » jscend,string(date-time),false,none,End date and time of the schedule. » jscweekdays,[boolean],false,none,List of weekdays for the schedule. » jscmonthdays,[boolean],false,none,List of month days for the schedule. » jscmonths,[boolean],false,none,List of months for the schedule. » jschours,[boolean],false,none,List of hours for the schedule. » jscminutes,[boolean],false,none,List of minutes for the schedule. » jscexceptions,[any],false,none,List of exceptions for the schedule. » jsctimezone,string,false,none,Timezone of the schedule. AgentJobBodyPut --------------- .. code:: json { "jobname": "string", "jobenabled": true, "jobdesc": "string", "jsteps": { "added": [ { "jstname": "string", "jstdesc": "string", "jstenabled": true, "jstkind": true, "jstcode": "string", "server_id": 0, "database_name": "string", "jstonerror": "f" } ], "changed": [ { "jstid": 0, "jstname": "string", "jstdesc": "string", "jstenabled": true, "jstkind": true, "jstcode": "string", "server_id": 0, "database_name": "string", "jstonerror": "f", "jstnextrun": "string" } ] }, "jschedules": { "added": [ { "jscname": "string", "jscdesc": "string", "jscenabled": true, "jscstart": "2023-10-09 22:43 +05:30", "jscend": "2023-10-11 22:43 +05:30", "jscweekdays": "Monday", "jscmonthdays": 1, "jscmonths": "January", "jschours": 0, "jscminutes": 0, "jscexceptions": [ { "jexdate": "2023-10-19", "jextime": "09:39:00" } ], "jsctimezone": "Asia/Calcutta" } ], "changed": [ { "jscid": 0, "jscname": "string", "jscdesc": "string", "jscenabled": true, "jscstart": "2023-10-09 22:43 +05:30", "jscend": "2023-10-11 22:43 +05:30", "jscweekdays": "Monday", "jscmonthdays": 1, "jscmonths": "January", "jschours": 0, "jscminutes": 0, "jscexceptions": [ { "jexdate": "2023-10-19", "jextime": "09:39:00" } ], "jsctimezone": "Asia/Calcutta" } ] }, "notify": "DEFAULT", "email_group_id": "string" } .. _properties-57: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable jobname,string,false,none,Name of the job. jobenabled,boolean,false,none,Determines whether the job is enabled or disabled. jobdesc,string,false,none,Description of the job. jsteps,object,false,none,none » added,[object],false,none,List of added steps. »» jstname,string,false,none,Name of the step. »» jstdesc,string,false,none,Description of the step. »» jstenabled,boolean,false,none,Determines whether the step is enabled or disabled. »» jstkind,boolean,false,none,"Determines the kind of the step. True for SQL step, False for Batch step." »» jstcode,string,false,none,Code or script for the step. »» server_id,integer,false,none,ID of the server associated with the step. »» database_name,string,false,none,Name of the database associated with the step. »» jstonerror,string,false,none,"Specifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore')." » changed,[object],false,none,List of changed steps. »» jstid,integer,false,none,ID of the step. »» jstname,string,false,none,Name of the step. »» jstdesc,string,false,none,Description of the step. »» jstenabled,boolean,false,none,Determines whether the step is enabled or disabled. »» jstkind,boolean,false,none,"Determines the kind of the step. True for SQL step, False for Batch step." »» jstcode,string,false,none,Code or script for the step. »» server_id,integer,false,none,ID of the server associated with the step. »» database_name,string,false,none,Name of the database associated with the step. »» jstonerror,string,false,none,"Specifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore')." »» jstnextrun,string,false,none,none jschedules,object,false,none,none » added,[object],false,none,List of added schedules. »» jscname,string,false,none,Name of the schedule. »» jscdesc,string,false,none,Description of the schedule. »» jscenabled,boolean,false,none,Determines whether the schedule is enabled or disabled. »» jscstart,string,false,none,Start date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). »» jscend,string,false,none,End date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). »» jscweekdays,[any],false,none,List of weekdays for the schedule. »» jscmonthdays,[any],false,none,"List of month days for the schedule.Note: Here,'32' represents Last Day of the Month" »» jscmonths,[any],false,none,List of months for the schedule. »» jschours,[any],false,none,List of hours(0-23) for the schedule. »» jscminutes,[any],false,none,List of minutes(0-59) for the schedule. »» jscexceptions,[object],false,none,List of exceptions for the schedule. »»» jexdate,string(date),false,none,Date of the schedule exception. »»» jextime,string(time),false,none,Time of the schedule exception. »» jsctimezone,string,false,none,Timezone of the schedule. » changed,[object],false,none,List of changed schedules. »» jscid,integer¦null,false,none,ID of the schedule. »» jscname,string,false,none,Name of the schedule. »» jscdesc,string,false,none,Description of the schedule. »» jscenabled,boolean,false,none,Determines whether the schedule is enabled or disabled. »» jscstart,string,false,none,Start date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). »» jscend,string,false,none,End date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). »» jscweekdays,[any],false,none,List of weekdays for the schedule. »» jscmonthdays,[any],false,none,"List of month days for the schedule.Note: Here,'32' represents Last Day of the Month" »» jscmonths,[any],false,none,List of months for the schedule. »» jschours,[any],false,none,List of hours(0-23) for the schedule. »» jscminutes,[any],false,none,List of minutes(0-59) for the schedule. »» jscexceptions,[object],false,none,List of exceptions for the schedule. »»» jexdate,string(date),false,none,Date of the schedule exception. »»» jextime,string(time),false,none,Time of the schedule exception. »» jsctimezone,string,false,none,Timezone of the schedule. notify,string,false,none,Notification setting for the job. email_group_id,string,false,none,ID of the email group for notifications. .. _enumerated-values-22: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable jstonerror,f jstonerror,s jstonerror,i jstonerror,f jstonerror,s jstonerror,i jscweekdays,Monday jscweekdays,Tuesday jscweekdays,Wednesday jscweekdays,Thursday jscweekdays,Friday jscweekdays,Saturday jscweekdays,Sunday jscmonthdays,1 jscmonthdays,2 jscmonthdays,3 jscmonthdays,4 jscmonthdays,5 jscmonthdays,6 jscmonthdays,7 jscmonthdays,8 jscmonthdays,9 jscmonthdays,10 jscmonthdays,11 jscmonthdays,12 jscmonthdays,13 jscmonthdays,14 jscmonthdays,15 jscmonthdays,16 jscmonthdays,17 jscmonthdays,18 jscmonthdays,19 jscmonthdays,20 jscmonthdays,21 jscmonthdays,22 jscmonthdays,23 jscmonthdays,24 jscmonthdays,25 jscmonthdays,26 jscmonthdays,27 jscmonthdays,28 jscmonthdays,29 jscmonthdays,30 jscmonthdays,31 jscmonthdays,32 jscmonths,January jscmonths,February jscmonths,March jscmonths,April jscmonths,May jscmonths,June jscmonths,July jscmonths,August jscmonths,September jscmonths,October jscmonths,November jscmonths,December jschours,0 jschours,1 jschours,2 jschours,3 jschours,4 jschours,5 jschours,6 jschours,7 jschours,8 jschours,9 jschours,10 jschours,22 jscminutes,0 jscminutes,1 jscminutes,2 jscminutes,3 jscminutes,4 jscminutes,5 jscminutes,6 jscminutes,7 jscminutes,8 jscminutes,9 jscminutes,10 jscminutes,31 jscminutes,32 jscminutes,33 jscminutes,34 jscminutes,35 jscminutes,36 jscminutes,37 jscminutes,38 jscminutes,39 jscminutes,51 jscminutes,52 jscminutes,53 jscminutes,54 jscminutes,55 jscminutes,56 jscminutes,57 jscminutes,58 jscminutes,59 jsctimezone,Asia/Calcutta jsctimezone,Canada/Pacific jsctimezone,Asia/Tokyo jsctimezone,etc jscweekdays,Monday jscweekdays,Tuesday jscweekdays,Wednesday jscweekdays,Thursday jscweekdays,Friday jscweekdays,Saturday jscweekdays,Sunday jscmonthdays,1 jscmonthdays,2 jscmonthdays,3 jscmonthdays,4 jscmonthdays,5 jscmonthdays,6 jscmonthdays,7 jscmonthdays,8 jscmonthdays,9 jscmonthdays,10 jscmonthdays,11 jscmonthdays,12 jscmonthdays,13 jscmonthdays,14 jscmonthdays,15 jscmonthdays,16 jscmonthdays,17 jscmonthdays,18 jscmonthdays,19 jscmonthdays,20 jscmonthdays,21 jscmonthdays,22 jscmonthdays,23 jscmonthdays,24 jscmonthdays,25 jscmonthdays,26 jscmonthdays,27 jscmonthdays,28 jscmonthdays,29 jscmonthdays,30 jscmonthdays,31 jscmonthdays,32 jscmonths,January jscmonths,February jscmonths,March jscmonths,April jscmonths,May jscmonths,June jscmonths,July jscmonths,August jscmonths,September jscmonths,October jscmonths,November jscmonths,December jschours,0 jschours,1 jschours,2 jschours,3 jschours,4 jschours,5 jschours,6 jschours,7 jschours,8 jschours,9 jschours,10 jschours,22 jscminutes,0 jscminutes,1 jscminutes,2 jscminutes,3 jscminutes,4 jscminutes,5 jscminutes,6 jscminutes,7 jscminutes,8 jscminutes,9 jscminutes,10 jscminutes,31 jscminutes,32 jscminutes,33 jscminutes,34 jscminutes,35 jscminutes,36 jscminutes,37 jscminutes,38 jscminutes,39 jscminutes,51 jscminutes,52 jscminutes,53 jscminutes,54 jscminutes,55 jscminutes,56 jscminutes,57 jscminutes,58 jscminutes,59 jsctimezone,Asia/Calcutta jsctimezone,Canada/Pacific jsctimezone,Asia/Tokyo jsctimezone,etc notify,DEFAULT notify,ON_FAILURE notify,ALWAYS notify,NEVER AgentJobBodyPost ---------------- .. code:: json { "jobname": "string", "jobenabled": true, "jobdesc": "string", "jsteps": [], "jschedules": [ { "jscname": "string", "jscdesc": "string", "jscenabled": true, "jscstart": "2023-10-09 22:43 +05:30", "jscend": "2023-10-11 22:43 +05:30", "jscweekdays": "Monday", "jscmonthdays": 1, "jscmonths": "January", "jschours": 0, "jscminutes": 0, "jscexceptions": [ { "jexdate": "2023-10-19", "jextime": "09:39:00" } ], "jsctimezone": "Asia/Calcutta" } ], "notify": "DEFAULT", "email_group_id": "string" } .. _properties-58: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable jobname,string,false,none,Name of the job. jobenabled,boolean,false,none,Determines whether the job is enabled or disabled. jobdesc,string,false,none,Description of the job. jsteps,[object],false,none,List of steps for the job. » jstname,string,false,none,Name of the step. » jstdesc,string,false,none,Description of the step. » jstenabled,boolean,false,none,Determines whether the step is enabled or disabled. » jstkind,boolean,false,none,"Determines the kind of the step. True for SQL step, False for Batch step." » jstcode,string,false,none,Code or script for the step. » server_id,integer,false,none,ID of the server associated with the step. » database_name,string,false,none,Name of the database associated with the step. » jstonerror,string,false,none,"Specifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore')." jschedules,[object],false,none,List of schedules for the job. » jscname,string,false,none,Name of the schedule. » jscdesc,string,false,none,Description of the schedule. » jscenabled,boolean,false,none,Determines whether the schedule is enabled or disabled. » jscstart,string,false,none,Start date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). » jscend,string,false,none,End date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm). » jscweekdays,[any],false,none,List of weekdays for the schedule. » jscmonthdays,[any],false,none,"List of month days for the schedule.Note: Here,'32' represents Last Day of the Month" » jscmonths,[any],false,none,List of months for the schedule. » jschours,[any],false,none,List of hours(0-23) for the schedule. » jscminutes,[any],false,none,List of minutes(0-59) for the schedule. » jscexceptions,[object],false,none,List of exceptions for the schedule. »» jexdate,string(date),false,none,Date of the schedule exception. »» jextime,string(time),false,none,Time of the schedule exception. » jsctimezone,string,false,none,Timezone of the schedule. notify,string,false,none,Notification setting for the job. email_group_id,string,false,none,ID of the email group for notifications. .. _enumerated-values-23: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable jstonerror,f jstonerror,s jstonerror,i jscweekdays,Monday jscweekdays,Tuesday jscweekdays,Wednesday jscweekdays,Thursday jscweekdays,Friday jscweekdays,Saturday jscweekdays,Sunday jscmonthdays,1 jscmonthdays,2 jscmonthdays,3 jscmonthdays,4 jscmonthdays,5 jscmonthdays,6 jscmonthdays,7 jscmonthdays,8 jscmonthdays,9 jscmonthdays,10 jscmonthdays,11 jscmonthdays,12 jscmonthdays,13 jscmonthdays,14 jscmonthdays,15 jscmonthdays,16 jscmonthdays,17 jscmonthdays,18 jscmonthdays,19 jscmonthdays,20 jscmonthdays,21 jscmonthdays,22 jscmonthdays,23 jscmonthdays,24 jscmonthdays,25 jscmonthdays,26 jscmonthdays,27 jscmonthdays,28 jscmonthdays,29 jscmonthdays,30 jscmonthdays,31 jscmonthdays,32 jscmonths,January jscmonths,February jscmonths,March jscmonths,April jscmonths,May jscmonths,June jscmonths,July jscmonths,August jscmonths,September jscmonths,October jscmonths,November jscmonths,December jschours,0 jschours,1 jschours,2 jschours,3 jschours,4 jschours,5 jschours,6 jschours,7 jschours,8 jschours,9 jschours,10 jschours,22 jscminutes,0 jscminutes,1 jscminutes,2 jscminutes,3 jscminutes,4 jscminutes,5 jscminutes,6 jscminutes,7 jscminutes,8 jscminutes,9 jscminutes,10 jscminutes,31 jscminutes,32 jscminutes,33 jscminutes,34 jscminutes,35 jscminutes,36 jscminutes,37 jscminutes,38 jscminutes,39 jscminutes,51 jscminutes,52 jscminutes,53 jscminutes,54 jscminutes,55 jscminutes,56 jscminutes,57 jscminutes,58 jscminutes,59 jsctimezone,Asia/Calcutta jsctimezone,Canada/Pacific jsctimezone,Asia/Tokyo jsctimezone,etc notify,DEFAULT notify,ON_FAILURE notify,ALWAYS notify,NEVER Database -------- .. code:: json { "database_name": "string", "connections_allowed": true, "system_database": true, "recorded_time": "2019-08-24T14:15:22Z", "encoding": "string", "server_id": 0 } .. _properties-59: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable database_name,string,false,none,Database name connections_allowed,boolean,false,none,Determines whether a connection to the database is allowed. system_database,boolean,false,none,Determines whether the database is a system database. recorded_time,string(date-time),false,none,Specifies when the database was first detected by the PEM agent. encoding,string,false,none,Database encoding server_id,integer,false,none,Server ID of database Schema ------ .. code:: json { "schema_name": "string", "database_name": "string", "server_id": 0, "recorded_time": "2019-08-24T14:15:22Z" } .. _properties-60: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable schema_name,string,false,none,Schema name database_name,string,false,none,Database name of schema server_id,integer,false,none,Server ID schema recorded_time,string(date-time),false,none,Specifies when schema was first detected by PEM agent. Table ----- .. code:: json { "table_name": "string", "schema_name": "string", "database_name": "string", "server_id": 0, "has_primary_key": true, "recorded_time": "string" } .. _properties-61: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable table_name,string,false,none,Table name schema_name,string,false,none,Schema name database_name,string,false,none,Database name server_id,integer,false,none,Server ID has_primary_key,boolean,false,none,Determines whether table has a primary key. recorded_time,string,false,none,Specifies when table was first detected by the PEM agent. Index ----- .. code:: json { "index_name": "string", "ind_keys": [ 0 ], "table_name": "string", "schema_name": "string", "database_name": "string", "server_id": 0, "recorded_time": "string" } .. _properties-62: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable index_name,string,false,none,Index name ind_keys,[integer],false,none,Indexed column positions in table table_name,string,false,none,Table name schema_name,string,false,none,Schema database_name,string,false,none,Database name server_id,integer,false,none,Server ID recorded_time,string,false,none,Specifies when index was first detected by PEM agent. Sequence -------- .. code:: json { "sequence_name": "string", "schema_name": "string", "database_name": "string", "server_id": 0, "recorded_time": "2019-08-24T14:15:22Z" } .. _properties-63: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable sequence_name,string,false,none,Sequence name schema_name,string,false,none,Schema name database_name,string,false,none,Database name server_id,integer,false,none,Server ID recorded_time,string(date-time),false,none,Specifies when sequence was first detected by PEM agent. Function -------- .. code:: json { "function_name": "string", "function_type": "string", "return_type": "string", "arg_types": [ "string" ], "function_binary": "string", "extension_name": "string", "package_name": "string", "schema_name": "string", "database_name": "string", "server_id": 0, "recorded_time": "2019-08-24T14:15:22Z" } .. _properties-64: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable function_name,string,false,none,Function name function_type,string,false,none,Function type return_type,string,false,none,Function return type arg_types,[string],false,none,Function argument types function_binary,string,false,none,none extension_name,string,false,none,none package_name,string,false,none,Function package name schema_name,string,false,none,Function schema database_name,string,false,none,Function database name server_id,integer,false,none,Function server id recorded_time,string(date-time),false,none,Specifies when function was first detected by PEM agent. View ---- .. code:: json { "view_name": "string", "view_type": "string", "ispopulated": true, "view_owner": "string", "definition": "string", "tablespace_name": "string", "schema_name": "string", "database_name": "string", "server_id": 0, "recorded_time": "string" } .. _properties-65: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable view_name,string,false,none,View name view_type,string,false,none,View type ispopulated,boolean,false,none,Determines whether the view is populated. view_owner,string,false,none,View owner definition,string,false,none,View definition tablespace_name,string,false,none,View tablespace schema_name,string,false,none,View schema database_name,string,false,none,View database server_id,integer,false,none,View server ID recorded_time,string,false,none,Specifies when view was first detected by PEM agent. Webhook ------- .. code:: json { "id": 0, "name": "string", "url": "string", "enabled": true, "method": "POST", "http_headers": [ { "http_header_id": 0, "http_header_key": "string", "http_header_value": "string" } ], "payload_template": "{text: You have new alert from PEM, attachments: [{text: AlertID \n%AlertID% \nAlertName \n%AlertName%}]}", "low_alert": true, "med_alert": true, "high_alert": true, "cleared_alert": true, "payload_type": "ALERT" } .. _properties-66: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Webhook ID name,string,false,none,Webhook name url,string,false,none,Webhook URL enabled,boolean,false,none,Determines whether the webhook is enabled. method,string,false,none,Request method http_headers,\ :ref:`Query information ` ],false,none,List of the HTTP header key/value pairs to be used by the webhook payload_template,string,false,none,Payload template. Below is payload example for slack. low_alert,boolean,false,none,Determines whether the low alert is enabled. med_alert,boolean,false,none,Determines whether the medium alert is enabled. high_alert,boolean,false,none,Determines whether the high alert is enabled. cleared_alert,boolean,false,none,Determines whether the cleared alert is enabled. payload_type,string,false,none,Payload type .. _enumerated-values-24: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable method,POST method,PUT payload_type,ALERT payload_type,JOB WebhookPostData --------------- .. code:: json { "name": "string", "url": "string", "enabled": true, "method": "POST", "http_headers": [ { "http_header_key": "string", "http_header_value": "string" } ], "payload_template": "{ Alert Name:%AlertName%,type:Webhook }", "low_alert": true, "med_alert": true, "high_alert": true, "cleared_alert": true, "payload_type": "ALERT" } .. _properties-67: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Webhook name url,string,false,none,Webhook URL enabled,boolean,false,none,Determines whether the webhook is enabled. method,string,false,none,Request method http_headers,\ :ref:`Query information ` ],false,none,List of the HTTP header key/value pairs to be used by the webhook payload_template,string,false,none,Payload template low_alert,boolean,false,none,Determines whether the low alert is enabled. med_alert,boolean,false,none,Determines whether the medium alert is enabled. high_alert,boolean,false,none,Determines whether the high alert is enabled. cleared_alert,boolean,false,none,Determines whether the cleared alert is enabled. payload_type,string,false,none,Payload type .. _enumerated-values-25: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable method,POST method,PUT payload_type,ALERT payload_type,JOB WebhookPutData -------------- .. code:: json { "name": "string", "url": "string", "enabled": true, "method": "POST", "http_headers": { "added": [ { "http_header_key": "string", "http_header_value": "string" } ], "changed": [ { "http_header_id": 0, "http_header_key": "string", "http_header_value": "string" } ], "deleted": [ { "http_header_id": 0 } ], "payload_type": "ALERT" }, "payload_template": "{text: You have new alert from PEM, attachments: [{text: AlertID \n%AlertID% \nAlertName \n%AlertName%}]}", "low_alert": true, "med_alert": true, "high_alert": true, "cleared_alert": true } .. _properties-68: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Webhook name url,string,false,none,Webhook URL enabled,boolean,false,none,Determines whether the webhook is enabled. method,string,false,none,Request method http_headers,object,false,none,none » added,\ :ref:`Query information ` ],false,none,List of the HTTP header key/value pairs to be added » changed,\ :ref:`Query information ` ],false,none,List of the HTTP header key/value pairs to be updated » deleted,[object],false,none,List of the HTTP header IDs to be deleted »» http_header_id,integer,false,none,ID of the HTTP header » payload_type,string,false,none,Payload type payload_template,string,false,none,Payload template. Below is payload example for slack. low_alert,boolean,false,none,Determines whether the low alert is enabled. med_alert,boolean,false,none,Determines whether the medium alert is enabled. high_alert,boolean,false,none,Determines whether the high alert is enabled. cleared_alert,boolean,false,none,Determines whether the cleared alert is enabled. .. _enumerated-values-26: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable method,POST method,PUT payload_type,ALERT payload_type,JOB WebhookGetHTTPHeaders --------------------- .. code:: json { "http_header_id": 0, "http_header_key": "string", "http_header_value": "string" } .. _properties-69: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable http_header_id,integer,false,none,ID of the HTTP header http_header_key,string,false,none,Name of the HTTP header key http_header_value,string,false,none,Name of the HTTP header key WebhookHTTPHeaders ------------------ .. code:: json { "http_header_key": "string", "http_header_value": "string" } .. _properties-70: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable http_header_key,string,false,none,Name of the HTTP header key http_header_value,string,false,none,Name of the HTTP header key EmailGroups ----------- .. code:: json { "id": 0, "oid": 0, "gid": 0, "name": "string", "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } .. _properties-71: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable id,integer,false,none,Email group ID oid,integer,false,none,Email group options ID gid,integer,false,none,Email group ID name,string,false,none,Email group name to_addr,string,false,none,Email group options receiver address cc_addr,string,false,none,Email group options CC address bcc_addr,string,false,none,Email group options BCC address from_addr,string,false,none,Email group options sender address reply_to_addr,string,false,none,Email group options reply to address subject_prefix,string,false,none,Email group options subject prefix from_time,string,false,none,Email group options from time to select time range for members to_time,string,false,none,Email group options to time to select time range for members EmailGroupsPostData ------------------- .. code:: json { "name": "string", "options": [ { "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } ] } .. _properties-72: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Email group name options,\ :ref:`[EmailGroupOptions <#tocs_emailgroupoptions>` ],false,none,List of the email group options to be used by the email group EmailGroupsPutData ------------------ .. code:: json { "name": "string", "options": { "added": [ { "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } ], "changed": [ { "oid": 0, "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } ], "deleted": [ { "oid": 0 } ] } } .. _properties-73: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable name,string,false,none,Email group name options,object,false,none,none » added,\ :ref:`[EmailGroupOptions <#tocs_emailgroupoptions>` ],false,none,Email group options to be added » changed,\ :ref:`[EmailGroupOptionsChanged <#tocs_emailgroupoptionschanged>` ],false,none,Email group options to be updated. » deleted,[object],false,none,List of the HTTP header IDs to be deleted »» oid,integer,false,none,Email group options ID EmailGroupOptions ----------------- .. code:: json { "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } .. _properties-74: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable to_addr,string,false,none,Email group options receiver address cc_addr,string,false,none,Email group options CC address bcc_addr,string,false,none,Email group options BCC address from_addr,string,false,none,Email group options sender address reply_to_addr,string,false,none,Email group options reply to address subject_prefix,string,false,none,Email group options subject prefix from_time,string,false,none,Email group options from time to select time range for members to_time,string,false,none,Email group options to time to select time range for members EmailGroupOptionsChanged ------------------------ .. code:: json { "oid": 0, "to_addr": "string", "cc_addr": "string", "bcc_addr": "string", "from_addr": "string", "reply_to_addr": "string", "subject_prefix": "string", "from_time": "00:00:00", "to_time": "23:59:59" } .. _properties-75: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable oid,integer,false,none,Email group options ID to_addr,string,false,none,Email group options receiver address cc_addr,string,false,none,Email group options CC address bcc_addr,string,false,none,Email group options BCC address from_addr,string,false,none,Email group options sender address reply_to_addr,string,false,none,Email group options reply to address subject_prefix,string,false,none,Email group options subject prefix from_time,string,false,none,Email group options from time to select time range for members to_time,string,false,none,Email group options to time to select time range for members ExcludeDatabases ---------------- .. code:: json { "server_id": 0, "name": "string", "exclude_databases": [ "string" ] } .. _properties-76: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable server_id,integer,false,none,Server ID name,string,false,none,Server name exclude_databases,[string],false,none,Exclude database names (comma separated) ExcludeDatabasesPutData ----------------------- .. code:: json { "exclude_databases": [ "string" ] } .. _properties-77: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable exclude_databases,[string],false,none,Exclude database names (comma separated)