EDB Postgres Enterprise Manager REST APIs v11.0: Schemas v10.4

Suggest edits

AlertPayload

{
  "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

NameTypeRequiredRestrictionsDescription
alert_namestringfalsenoneName of the alert. NOTE: This property is a mandatory parameter for a POST request.
alert_templateintegerfalsenoneID of the alert template. The ID must be a positive integer value. NOTE: This property is a mandatory parameter for a POST request.
descriptionstringfalsenonenone
enabledbooleanfalsenoneDefines whether this alert is enabled/disabled. NOTE: This property is a mandatory parameter for a POST request.
history_retentionintegerfalsenoneSpecifies 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_minintegerfalsenoneDefines 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.
operatorstringfalsenoneDefines the operator for checking threshold values. Valid string are ">" and "<". NOTE: This property is a mandatory parameter for the POST request.
low_threshold_valuenumberfalsenoneThreshold 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_valuenumberfalsenoneThreshold 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_valuenumberfalsenoneThreshold 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_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent, when the state of the alert changes.
low_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notifications are sent when the state of the alert changes to LOW.
med_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notifications are sent when the state of the alert changes to MEDIUM.
high_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent when the state of the alert changes to HIGH.
send_trapbooleanfalsenoneDetermines whether to send an SNMP trap notification when the state of the alert changes.
snmp_trap_versionintegerfalsenoneDefines the SNMP trap version. Supported SNMP trap versions are 1, 2 or 3.
low_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notifications when the state of the alert changes to LOW.
med_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notifications when the state of the alert changes to MEDIUM.
high_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notifications when the state of the alert chagnes to HIGH.
cleared_alert_enablebooleanfalsenoneDetermines whether to mute the notification for 'clear alert'.
params[AlertParams]falsenoneList 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_scriptbooleanfalsenoneDetermines whether to execute the provided script if the state of the alert changes to LOW/MEDIUM/HIGH.
execute_script_on_clearbooleanfalsenoneDetermines whether to execute the provided script if the state of the alert clears.
execute_script_on_pem_serverbooleanfalsenoneDetermines whether to execute the provided script on the PEM host or the host where the agent is monitoring the object.
script_codestringfalsenoneThe shell or batch script to be executed. Please read the documentation for detailed information.
submit_to_nagiosbooleanfalsenoneDefines whether to send notification to the nagios, when state of the alert is chagned.
override_default_configbooleanfalsenoneDetermines whether to override the default webhook configuration.
send_notificationbooleanfalsenoneDetermines whether the webhook send notification is enabled.
low_webhook_ids[integer]falsenoneDefines webhook IDs for which low alerts can be configured.
med_webhook_ids[integer]falsenoneDefines webhook IDs for which medium alerts can be configured.
high_webhook_ids[integer]falsenoneDefines webhook IDs for which high alerts can be configured.
cleared_webhook_ids[integer]falsenoneDefines webhook IDs for which cleared alerts can be configured.

Alert

{
  "id": 0,
  "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,
  "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,
  "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": true,
  "low_webhook_ids": [
    0
  ],
  "med_webhook_ids": [
    0
  ],
  "high_webhook_ids": [
    0
  ],
  "cleared_webhook_ids": [
    0
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneAlert ID. NOTE: This property is not applicable for a POST request.
alert_namestringfalsenoneName of the alert. NOTE: This property is a mandatory parameter for a POST request.
alert_templateintegerfalsenoneID of the alert template. This property must be a positive integer value. NOTE: It is a mandatory parameter for a POST request.
descriptionstringfalsenonenone
enabledbooleanfalsenoneDetermines whether this alert is enabled/disabled. NOTE: This property is a mandatory parameter for a POST request.
history_retentionintegerfalsenoneSpecifies 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_minintegerfalsenoneDefines 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.
operatorstringfalsenoneDefines the operator for checking threshold values. Valid strings are ">" and "<". NOTE: This property is a mandatory parameter for a POST request.
low_threshold_valuenumberfalsenoneThreshold 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_valuenumberfalsenoneThreshold 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_valuenumberfalsenoneThreshold 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_emailbooleanfalsenoneDetermines whether to send an email when the state of the alert changes.
all_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent when the state of the alert changes.
low_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent when the state of the alert changes to LOW.
med_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent when state of the alert changes to MEDIUM.
high_alert_enablebooleanfalsenoneDetermines 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_idintegerfalsenoneDefines the email group to which email notification are sent when the state of the alert changes to HIGH.
send_trapbooleanfalsenoneDetermines whether to send SNMP trap notifications when the state of the alert changes.
snmp_trap_versionintegerfalsenoneDefines the SNMP trap version. Supported SNMP trap versions are 1, 2 or 3
low_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notifications when the state of the alert changes to LOW.
med_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notification when the state of the alert changes to MEDIUM.
high_send_trapbooleanfalsenoneDetermines whether to send SNMP trap notification when the state of the alert changes to HIGH.
cleared_alert_enablebooleanfalsenoneDetermines whether to mute the notification for 'clear alert'.
params[AlertParams]falsenoneList 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_scriptbooleanfalsenoneDetermines whether to execute the provided script if the state of the alert changes to LOW/MEDIUM/HIGH.
execute_script_on_clearbooleanfalsenoneDetermines whether to execute the provided script if the state of the alert is cleared.
execute_script_on_pem_serverbooleanfalsenoneDetermines whether to execute the provided script on the PEM host or the host where the agent is monitoring the object.
script_codestringfalsenoneThe shell or batch script to be executed. Please read the documentation for detailed information.
submit_to_nagiosbooleanfalsenoneDetermines whether to send notification to the nagios when the state of the alert changes.
override_default_configbooleanfalsenoneDetermines whether to override the default webhook configuration.
send_notificationbooleanfalsenoneDetermines whether to enable the webhook send notification.
low_webhook_ids[integer]falsenoneWebhook IDs for which low alerts are configured
med_webhook_ids[integer]falsenoneWebhook IDs for which medium alerts are configured
high_webhook_ids[integer]falsenoneWebhook IDs for which high alerts are configured
cleared_webhook_ids[integer]falsenoneWebhook IDs for which cleared alerts are configured

AlertParams

{
  "paramname": "Exclude tables smaller than",
  "paramvalue": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
paramnamestringfalsenoneName of the parameter. NOTE: This property must present on the alert template parameter list.Example:
paramvaluestringfalsenoneValue for the given parameter
Enumerated Values
PropertyValue
paramnameExclude tables smaller than
paramnamemount point
paramnameHost IP Address
paramnameTime interval to monitor
paramnameTime since idle
paramnamePer CPU utilization (K%)

AlternateServerProbeCode

{
  "server_version_id": 0,
  "server_probe_code": "string",
  "extension_version": 0
}

Properties

NameTypeRequiredRestrictionsDescription
server_version_idintegerfalsenoneServer version ID for the monitored server
server_version_idDatabase Server
10905PostgreSQL 9.5
10906PostgreSQL 9.6
11000PostgreSQL 10
11100PostgreSQL 11
11200PostgreSQL 12
11300PostgreSQL 13
20905Postgres Plus Advanced Server 9.5
20906Postgres Plus Advanced Server 9.6
21000EDB Postgres Advanced Server 10
21100EDB Postgres Advanced Server 11
21200EDB Postgres Advanced Server 12
21300EDB Postgres Advanced Server 13
server_probe_codestringfalsenoneSQL query to run on the specified server version
extension_versionintegerfalsenoneSpecifies the extension version. Valid for extension target type

DeletedAlternateServerProbeCode

{
  "server_version_id": 0
}

Properties

NameTypeRequiredRestrictionsDescription
server_version_idintegerfalsenoneServer version ID for the monitored server
server_version_idDatabase Server
10905PostgreSQL 9.5
10906PostgreSQL 9.6
11000PostgreSQL 10
11100PostgreSQL 11
11200PostgreSQL 12
11300PostgreSQL 13
20905Postgres Plus Advanced Server 9.5
20906Postgres Plus Advanced Server 9.6
21000EDB Postgres Advanced Server 10
21100EDB Postgres Advanced Server 11
21200EDB Postgres Advanced Server 12
21300EDB Postgres Advanced Server 13

ProbeColumn

{
  "pc_id": 0,
  "pc_unit": "string",
  "pc_graphable": true
}

Properties

NameTypeRequiredRestrictionsDescription
pc_idintegerfalsenoneColumn identifier
pc_unitstringfalsenoneReturns the unit of the column.
pc_graphablebooleanfalsenoneDetermines whether the data of the column is graphable on a chart.

ChartExportTemplate

{
  "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

NameTypeRequiredRestrictionsDescription
chart_titlestringfalsenoneChart title. NOTE: This property is a mandatory parameter for a POST request.
chart_typestringfalsenoneChart catagory. NOTE: This property is a mandatory parameter for a POST request.
chart_categorystringfalsenoneChart type. NOTE: This property is a mandatory parameter for a POST request.
chart_descriptionstringfalsenoneDescription of the chart. NOTE: This property is a mandatory parameter for a POST request.
reference_idstringfalsenoneInternal identifier for the chart.
chart_levelintegerfalsenoneDefines the chart level. NOTE: This property is a mandatory parameter for a POST request.
chart_line_ext[integer]falsenoneDefines the line chart extrapolation. NOTE: This property is a mandatory parameter for a POST request.
chart_line_ext_metricstringfalsenoneDefines the line chart extrapolation metrics. NOTE: This property is a mandatory parameter for a POST request.
chart_line_ext_metric_options[integer]falsenoneDefines the line chart extrapolation metrics option. NOTE: This property is a mandatory parameter for a POST request.
chart_line_ext_optstringfalsenoneDefines the line chart extrapolation options. NOTE: This property is a mandatory parameter for a POST request.
chart_line_ext_valstringfalsenoneDefines the line chart extrapolation values. NOTE: This property is a mandatory parameter for a POST request.
chart_line_extrapolated_typestringfalsenoneDefines the line chart extrapolation type. NOTE: This property is a mandatory parameter for a POST request.
chart_line_pointsintegerfalsenoneDefines the line chart extrapolation point.
chart_line_span[integer]falsenoneDefines the line chart span. NOTE: This property is a mandatory parameter for a POST request.
chart_refreshintegerfalsenoneChart refresh time
espanintegerfalsenoneChart span
line_spanintegerfalsenoneChart line span
sel_metrics_L[object]falsenoneDefines the line chart metrics and its probes data.
sel_metrics_T[object]falsenoneDefines the table chart metrics and its probes data.
sel_metrics_C[object]falsenoneDefines the capacity manager chart metrics and its probes data.
shared[integer]falsenoneDefines the role ID to which chart was shared.
shared_allbooleanfalsenoneDetermines whether the chart needs to be shared with everyone.

DashboardExportTemplate

{
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneDefines the dashboard name. NOTE: This property is a mandatory parameter for a POST request.
descpstringfalsenoneProvides the dashboard description.
reference_idstringfalsenoneInternal identifier for the dashboard
fontstringfalsenoneDefines the dashboard font.
font_sizeintegerfalsenoneDefines the dashboard font size.
levelintegerfalsenoneDefines the dashboard level.
is_opsbooleanfalsenoneDetermines whether the dashboard is for ops.
show_titlebooleanfalsenoneDetermines whether the dashboard title is shown.
design_layout[object]falsenoneDefines the dashboard design layout data.
c_charts[object]falsenoneDefines the dependant custom charts and its probes data.
shared[integer]falsenoneDefines the role ID to which the dashboard is shared.
shared_allbooleanfalsenoneDetermines whether the dashboard must be shared with everyone

CustomDashboardExportData

{
  "dashboards": [
    0
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
dashboards[integer]falsenoneList of the dashboard IDs

CustomDashboardExportResponseData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the dashboard export
dashboards[DashboardExportTemplate]falsenonenone

CustomDashboardImportPostData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the dashboard export
skip_overwritebooleanfalsenoneDetermines whether the existing chart can be skipped.
skip_overwrite_probebooleanfalsenoneDetermines whether the existing dependant probes can be skipped.
skip_overwrite_chartbooleanfalsenoneDetermines whether the existing dependant charts can be skipped.
dashboards[DashboardExportTemplate]falsenonenone

CustomChartExportData

{
  "charts": [
    0
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
charts[integer]falsenoneList of the chart IDs

CustomChartExportResponseData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the chart export
charts[ChartExportTemplate]falsenonenone

CustomChartImportPostData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the chart export
skip_overwritebooleanfalsenoneDetermines whether the existing chart can be skipped.
skip_overwrite_probebooleanfalsenoneDetermines whether existing dependant probes can be skipped.
charts[ChartExportTemplate]falsenonenone

AlertImportExportTemplate

{
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneName of the alert template. NOTE: This property is a mandatory parameter for a POST request.
descriptionstringfalsenoneDescription of the alert template. NOTE: This property is a mandatory parameter for a POST request.
reference_idstringfalsenoneInternal identifier for the alert template
default_history_retentionintegerfalsenoneDefines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request.
object_typeintegerfalsenoneDefines the type of the object to which this alert template applies.
  • A system-wide alert template is 50.
  • An alert template applicable to an agent is 100.
  • An alert template applicable to a managed server is 200.
  • An alert template applicable to a database for a particular monitored server is 300.
  • An alert template applicable to a schema on a particular database for the managed server is 400.
  • An alert template applicable to a table on a particular schema for the database on a monitored server is 500.
  • An alert template applicable to an index on a particular schema for the database on a monitored server is 600.
  • An alert template applicable to a sequence on a particular schema for the database on a monitored server is 700.
  • An alert template applicable to a function on a particular schema for the database on a monitored server is 800.
NOTE: This property is a mandatory parameter for a POST request.
sqlstringfalsenoneSQL 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_serverstringfalsenoneSpecifies 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_frequencyintegerfalsenoneSpecifies 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_unitstringfalsenoneUnits used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI.
is_system_templatebooleanfalsenoneDetermines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests.
is_auto_createbooleanfalsenoneDetermines whether an alert should be created as soon as an agent or server is added to PEM..
thresholds[number]falsenoneDefault threshold values. Values in the thresholds array must be in a sorted order based on the operator.
operatorstringfalsenoneOperator to compare threshold values
high_threshold_valuestringfalsenoneHigh threshold value
medium_threshold_valuestringfalsenoneMedium threshold value
low_threshold_valuestringfalsenoneLow threshold value
info_sqlstringfalsenoneDefines the SQL query that provides detailed information about the alert on the dashboard.
probes[CustomProbeImportPostData]falsenonenone
Enumerated Values
PropertyValue
applicable_on_serverALL
applicable_on_serverPOSTGRES_SERVER
applicable_on_serverADVANCED_SERVER
operator>
operator<

CustomAlertTemplateExportData

{
  "alert_templates": [
    0
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
alert_templates[integer]falsenoneList of alert template IDs

CustomAlertTemplateExportResponseData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the alert template export
alert_templates[AlertImportExportTemplate]falsenonenone

CustomAlertTemplateImportPostData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the alert template export
skip_overwritebooleanfalsenoneDetermines whether the existing alert template can be skipped.
skip_overwrite_probebooleanfalsenoneDetermines whether existing dependent probes can be skipped.
alert_templates[AlertImportExportTemplate]falsenonenone

AlertTemplate

{
  "name": "string",
  "description": "string",
  "default_history_retention": 0,
  "object_type": 0,
  "sql": "string",
  "applicable_on_server": "ALL",
  "default_check_frequency": 0,
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneName of the alert template. NOTE: This property is a mandatory parameter for a POST request.
descriptionstringfalsenoneDescription of the alert template. NOTE: This property is a mandatory parameter for a POST request.
default_history_retentionintegerfalsenoneDefines the history retention period in days for this type of alerts. NOTE: This property is a mandatory parameter for a POST request.
object_typeintegerfalsenoneDefines the type of the object to which this alert template applies.
  • A system-wide alert template is 50.
  • An alert template applicable to an agent is 100.
  • An alert template applicable to a managed server is 200.
  • An alert template applicable to a database for a particular monitored server is 300.
  • An alert template applicable to a schema on a particular database for the managed server is 400.
  • An alert template applicable to a table on a particular schema for the database on a monitored server is 500.
  • An alert template applicable to an index on a particular schema for the database on a monitored server is 600.
  • An alert template applicable to a sequence on a particular schema for the database on a monitored server is 700.
  • An alert template applicable to a function on a particular schema for the database on a monitored server is 800.
NOTE: This property is a mandatory parameter for a POST request.
sqlstringfalsenoneSQL query, possibly parameterized, to get a numeric value indicating threshold reached. NOTE: This property is a mandatory parameter for a POST request.
applicable_on_serverstringfalsenoneSpecifies 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_frequencyintegerfalsenoneDefines how frequently (in minutes) to check for the alert defined in this template. NOTE: This property is a mandatory parameter for a POST request.
threshold_unitstringfalsenoneUnits used to calculate the threshold, such as MB/kB/seconds/days/... This value is only used for the GUI.
is_system_templatebooleanfalsenoneDetermines whether the given template is system-defined or user-defined. NOTE: This property is not applicable for POST/PUT requests.
is_auto_createbooleanfalsenoneDetermines 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.
operatorstringfalsenoneOperator to compare threshold values.Only supported for Agent and Server level i.e object_type 100 and 200 respectively.
low_threshold_valuenumberfalsenoneLow threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively.
medium_threshold_valuenumberfalsenoneMedium threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively.
high_threshold_valuenumberfalsenoneHigh threshold value.Only supported for Agent and Server level i.e object_type 100 and 200 respectively.
info_sqlstringfalsenoneSpecifies the SQL query that provides detailed information about the alert on the dashboard.
Enumerated Values
PropertyValue
applicable_on_serverALL
applicable_on_serverPOSTGRES_SERVER
applicable_on_serverADVANCED_SERVER
operator>
operator<

AlertHistory

{
  "alert_id": 0,
  "state": "High",
  "value": "string",
  "actual_value": 0
}

Properties

NameTypeRequiredRestrictionsDescription
alert_idintegerfalsenoneAlert ID
statestringfalsenoneState
valuestringfalsenoneUser-presentable value
actual_valuenumberfalsenoneActual value at the time of state change
Enumerated Values
PropertyValue
stateHigh
stateMedium
stateLow

ServerStatus

{
  "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

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneServer ID
namestringfalsenoneServer name
group_idintegerfalsenoneGroup ID under which database server is visible to the user
group_namestringfalsenoneGroup name
blackoutbooleanfalsenoneStatus of the alert blackout for the database server
statusstringfalsenoneServer status can be UP, DOWN, UNKNOWN, or UNMANAGED,
alertsobjectfalsenoneList of alerts configured for the database server, including alert status and number of alerts that are acknowledged
» totalintegerfalsenoneNumber of alerts configured for the database server
» acknowledgedintegerfalsenoneNumber of acknowledged alerts
» highintegerfalsenoneNumber of alerts with state as 'High'
» mediumintegerfalsenoneNumber of alerts with state as 'Medium'
» lowintegerfalsenoneNumber of alerts with state as 'Low'
» high_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'High'
» medium_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'Medium'
» low_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'Low'
versionstringfalsenoneCurrent version of the database server
number_connectionsintegerfalsenoneNumber of connections on the database servers
remote_monitoringbooleanfalsenoneDetermines whether the database server is being monitored remotely by the pemAgent
agent_idintegerfalsenoneAgent ID that is monitoring the database server
sessionsobjectfalsenoneAll the session information for database servers
» last_recorded_timenumberfalsenoneUnix time of the last recorded time for session information
» sessions[object]falsenoneList of all the session information for the database server
»» database_namestringfalsenoneDatabase name
»» procpidintegerfalsenoneProcess ID
»» usenamestringfalsenoneUser name
»» backend_startnumberfalsenoneUnix time for the session start time
»» xact_startnumberfalsenoneUnix time for the transaction start time
»» query_startnumberfalsenoneUnix time for the query start time (if any queries are running)
»» is_waitingbooleanfalsenoneIs the sesion waiting?
»» is_idlebooleanfalsenoneIs the session idle?
»» is_idle_in_transactionbooleanfalsenoneIs the session idle in a transaction?
»» is_vacuumbooleanfalsenoneIs this a VACUUM session?
»» is_autovacuumbooleanfalsenoneIs this an AUTO VACUUM session?
»» client_addrstringfalsenoneHost address for the client of the session
»» client_portintegerfalsenoneClient port for the session
»» memory_usage_mbnumberfalsenoneMemory usage (in MB) of the session (available only when monitored locally)
»» swap_usage_mbnumberfalsenoneSwap memory usage (in MB) of the session (available only when monitored locally)
»» cpu_usagenumberfalsenoneCPU Usage (in percentage) of the session (available only when monitored locally)
»» io_read_bytesnumberfalsenoneI/O Read (in bytes) of the session (available only when monitored locally)
»» io_write_bytesnumberfalsenoneI/O Write (in bytes) of the session (available only when monitored locally)
»» statestringfalsenoneCurrent state of the session (idle, active, idle in transcation, and so forth)
»» state_changenumberfalsenoneUnix time of the last state change in the session
Enumerated Values
PropertyValue
statusUP
statusDOWN
statusUNKNOWN
statusUNMANAGED

AgentStatus

{
  "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

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneAgent ID
namestringfalsenoneAgent name
group_idintegerfalsenoneGroup ID under which agent is visible to the user
group_namestringfalsenoneGroup name
blackoutbooleanfalsenoneDetermines whether an alert blackout for the agent is enabled or disabled.
statusstringfalsenoneAgent status can be UP, DOWN, or UNKNOWN
alertsobjectfalsenoneList of alerts configured for the agent, including alert status and number of alerts that are acknowledged
» totalintegerfalsenoneNumber of alerts configured for the agent
» acknowledgedintegerfalsenoneNumber of acknowledged alerts
» highintegerfalsenoneNumber of alerts with state as 'High'
» mediumintegerfalsenoneNumber of alerts with state as 'Medium'
» lowintegerfalsenoneNumber of alerts with state as 'Low'
» high_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'High'
» medium_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'Medium'
» low_acknowledgedintegerfalsenoneNumber of acknowledged alerts with state as 'Low'
versionstringfalsenoneCurrent version of the agent
processesintegerfalsenoneNumber of processes running
threadsintegerfalsenoneNumber of threads for all the running processes
cpu_utilizationnumberfalsenoneCPU utilization (percentage)
memory_utilizationnumberfalsenoneMemory utilization (percentage)
swap_utilizationnumberfalsenoneSwap memory utilization (percentage)
disk_utilizationnumberfalsenoneOverall disk utilization (percentage)
Enumerated Values
PropertyValue
statusUP
statusDOWN
statusUNKNOWN

AlertStatus

{
  "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

NameTypeRequiredRestrictionsDescription
alert_sincestringfalsenoneUnix time when alert state last changed
alert_idintegerfalsenoneAlert internal identification number
alert_namestringfalsenoneName of the alert
alert_statestringfalsenoneCurrent state of the alert. A 'null' value suggests alert threshold values have not currently been violated for the alert.
valuestringfalsenoneCurrent value of the alert
object_descriptionstringfalsenoneMonitoring object description/name
server_idintegerfalsenonenull or ID of the server
agent_idintegerfalsenonenull or ID of the agent
databasestringfalsenonenull or name of the database
schemastringfalsenonenull or name of the schema/namespace
packagestringfalsenonenull or name of the EDB package
objectstringfalsenonenull or name of any other type of object
alert_target_levelstringfalsenoneAlert target level
last_processedstringfalsenoneString reprenting Unix time when the alert was processed
infostringfalsenoneSome information at the time when the alert was generated
info_cols[string]falsenoneArray of column names for the information
info_vals[array]falsenoneDetailed information associated with the alert in the form of a table (an array of an array)
Enumerated Values
PropertyValue
alert_stateHigh
alert_stateMedium
alert_stateLow
alert_target_levelGlobal
alert_target_levelAgent
alert_target_levelServer
alert_target_levelDatabase
alert_target_levelSchema
alert_target_levelTable
alert_target_levelIndex
alert_target_levelSequence
alert_target_levelFunction
alert_target_levelView

CustomProbes

{
  "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

NameTypeRequiredRestrictionsDescription
probe_idintegerfalsenoneIdentifier for a probe
probe_namestringfalsenoneName of the probe
enabledbooleanfalsenoneDetermines whether the probe is enabled or disabled by default.
target_typeintegerfalsenoneDefines the type of the object to which the probe applies.
  • A probe with target_type 100 is responsible for collecting statistics for an agent.
  • A probe with target_type 200 is responsible for collecting statistics for a monitored server.
  • A probe with target_type 300 is responsible for collecting statistics for a database.
  • A probe with target_type 400 is responsible for collecting statistics for a schema.
  • A probe with target_type 500 is responsible for collecting statistics for a table.
  • A probe with target_type 600 is responsible for collecting statistics for a index.
  • A probe with target_type 700 is responsible for collecting statistics for a sequence.
  • A probe with target_type 800 is responsible for collecting statistics for a function.
  • A probe with target_type 900 is responsible for collecting statistics for a view.
  • A probe with target_type 1000 is responsible for collecting statistics for a extension.
internal_namestringfalsenoneDefines 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_probebooleanfalsenoneDetermines whether this probe is user-defined. This flag is always false for a user-defined probe.
any_server_versionbooleanfalsenoneDetermines whether this probe applies to any version of a Postgres variant. For more details, please consult the documentation.
collection_methodstringfalsenoneDefines the method of statistics collection. PEM supports three methods for custom made probes: SQL, WMI, or batch/shell script.
  • 'w' stands for WMI script.
    This type of script only applies to the Windows platform, and the target_type is 100 (for agent).
  • 'b' stands for batch/shell script. The 'target_type' for this script is always 100 (agent). This script behaves as a batch script on Windows and a shell script on other platforms.
  • 's' stands for SQL script. The 'target_type' is always 200 (server), 300 (database), 400 (schema), 500 (table), 600 (index), 700 (sequence), 800 (function), or 900 (view), or 1000 (extension).
intervalintegerfalsenoneDefines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10
lifetimeintegerfalsenoneDefines 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_historybooleanfalsenoneDetermines whether to discard history data. When 'discard_history' is set to false, history of the data for this probe is not stored.
platformstringfalsenoneDefines the platform where this probe can run. This value only applies to an agent-level probe.
probe_codestringfalsenoneA SQL/Batch script/Shell script/WMI script to collect the statistics as per the definition of the code.
probe_columns[object]falsenonenone
» pc_idintegerfalsenoneColumn identifier
» pc_namestringfalsenoneColumn name
» pc_data_typestringfalsenoneData type of the column.
Supported datatypes are:
      bigint
      char
      decimal
      double precision
      integer
      numeric
      real
      text
      text[]
      timestamp
      timestamptz
» pc_internal_namestringfalsenoneReturns the internal name of the column.
» pc_unitstringfalsenoneReturns the unit of the column.
» pc_col_typestringfalsenoneReturns 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_positionintegerfalsenoneReturns the position of the column in the internal table.
» pc_graphablebooleanfalsenoneDetermines whether the data of the column can be graphed on a chart.
» pc_calc_pitbooleanfalsenoneDetermines whether the server calculates the point-in-time for metric data for this column.
» pc_pit_defaultbooleanfalsenoneDetermines 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[AlternateServerProbeCode]falsenonenone
Enumerated Values
PropertyValue
collection_methodw
collection_methodb
collection_methods
platformunix
platformwindows
pc_data_typebigint
pc_data_typechar
pc_data_typedecimal
pc_data_typedouble precision
pc_data_typeinteger
pc_data_typenumeric
pc_data_typereal
pc_data_typetext
pc_data_typetext[]
pc_data_typetimestamp
pc_data_typetimestamptz
pc_col_typem
pc_col_typek

CustomProbeExportData

{
  "probes": [
    0
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
probes[integer]falsenoneList of the probe IDs for custom probes

CustomProbeImportData

{
  "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

NameTypeRequiredRestrictionsDescription
versionintegerfalsenoneVersion of the probe export
skip_overwritebooleanfalsenoneDetermines whether existing probes can be skipped.
probes[CustomProbeImportPostData]falsenonenone

CustomProbeImportPostData

{
  "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

allOf

NameTypeRequiredRestrictionsDescription
anonymousCustomProbePostDatafalsenonenone

and

NameTypeRequiredRestrictionsDescription
anonymousobjectfalsenonenone
» internal_namestringfalsenoneInternal name of the probe from the system where probe was exported

CustomProbePostData

{
  "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

NameTypeRequiredRestrictionsDescription
probe_namestringfalsenoneName of the probe
collection_methodstringfalsenoneDefines the method of statistics collection. PEM supports three methods for custom made probes: SQL, WMI, or batch/shell script.
  • 'w' stands for WMI script.
    This type of script only applies to the Windows platform, and the target_type is 100 (for agent).
  • 'b' stands for batch/shell script. The 'target_type' for this script is always 100 (agent). This script behaves as a batch script on Windows and a shell script on other platforms.
  • 's' stands for SQL script. The 'target_type' is always 200 (server), 300 (database), 400 (schema), 500 (table), 600 (index), 700 (sequence), 800 (function), 900 (view) or 1000 (extension).
enabledbooleanfalsenoneDetermines whether whether the probe is enabled/disabled by default.
target_typeintegerfalsenoneDefines the type of the object to which the probe applies.
  • A probe with target_type 100 is responsible for collecting statistics for an agent.
  • A probe with target_type 200 is responsible for collecting statistics for a monitored server.
  • A probe with target_type 300 is responsible for collecting statistics for a database.
  • A probe with target_type 400 is responsible for collecting statistics for a schema.
  • A probe with target_type 500 is responsible for collecting statistics for a table.
  • A probe with target_type 600 is responsible for collecting statistics for a index.
  • A probe with target_type 700 is responsible for collecting statistics for a sequence.
  • A probe with target_type 800 is responsible for collecting statistics for a function.
  • A probe with target_type 900 is responsible for collecting statistics for a view.
  • A probe with target_type 1000 is responsible for collecting statistics for a extension.
any_server_versionbooleanfalsenoneDetermines whether this probe applies to any version of a Postgres variant. For more details, please consult the documentation.
any_extension_versionbooleanfalsenoneDetermines whether this probe applies to any version of a Extension variant. For more details, please consult the documentation.
extension_namestringfalsenoneName of the extension.
    Valid names are edbspl , plpgsql , hstore , pldbgapi , edb_dblink_oci , edb_dblink_libpq , sslutils .
intervalintegerfalsenoneDefines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10
lifetimeintegerfalsenoneDefines 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_historybooleanfalsenoneDefines whether to discard history data. When 'discard_history' is set to false, no history data is stored for this probe.
platformstringfalsenoneDefines the platform where this probe can run. This value only applies to an agent-level probe.
probe_codestringfalsenoneA SQL/Batch script/Shell script/WMI script to collect the statistics as per definition of the code.
probe_columns[object]falsenonenone
» pc_namestringfalsenoneColumn name
» pc_data_typestringfalsenoneData type of the column.
Supported datatypes are:
      bigint
      char
      decimal
      double precision
      integer
      numeric
      real
      text
      text[]
      timestamp
      timestamptz
» pc_unitstringfalsenoneReturns the unit of the column.
» pc_col_typestringfalsenoneReturns 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_graphablebooleanfalsenoneDetermines whether the data of the column can be graphed on a chart.
» pc_calc_pitbooleanfalsenoneDetermines whether the server calculates point-in-time for metric data for this column.
» pc_pit_defaultbooleanfalsenoneDetermines 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[AlternateServerProbeCode]falsenonenone
Enumerated Values
PropertyValue
collection_methodw
collection_methodb
collection_methods
platformunix
platformwindows
pc_data_typebigint
pc_data_typechar
pc_data_typedecimal
pc_data_typedouble precision
pc_data_typeinteger
pc_data_typenumeric
pc_data_typereal
pc_data_typetext
pc_data_typetext[]
pc_data_typetimestamp
pc_data_typetimestamptz
pc_col_typem
pc_col_typek

CustomProbePutData

{
  "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

NameTypeRequiredRestrictionsDescription
interval_minintegerfalsenoneDefines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880.
interval_secintegerfalsenoneDefines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59.
lifetimeintegerfalsenoneDefines 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.
enabledbooleanfalsenoneDetermines whether the probe is enabled by default.
probe_codestringfalsenoneA SQL/Batch script/Shell script/WMI script to collect the statistics as per definition of the code.
probe_columnsobjectfalsenonenone
» changed[ProbeColumn]falsenoneList of the changed probe column
alternate_codeobjectfalsenonenone
» changed[AlternateServerProbeCode]falsenoneList of the changed alternate probe code for some server version
» deleted[DeletedAlternateServerProbeCode]falsenoneList of the deleted alternate probe code for some server versions
» added[AlternateServerProbeCode]falsenoneList of the alternate probe code added for some server versions

Probes

{
  "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

NameTypeRequiredRestrictionsDescription
probe_idintegerfalsenoneUnique ID of the probe
probe_namestringfalsenoneName of the probe
default_interval_minintegerfalsenoneDefines the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880.
interval_minintegerfalsenoneDefines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880.
default_interval_secintegerfalsenoneDefines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59.
interval_secintegerfalsenoneDefines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59.
default_intervalintegerfalsenoneDefines the default interval for the probe to collect statistics (in seconds).
intervalintegerfalsenoneDefines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10
default_lifetimeintegerfalsenoneDefines the default history data retention time (in days).
lifetimeintegerfalsenoneDefines 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_enabledbooleanfalsenoneDefines the default probe enabled/disabled value.
enabledbooleanfalsenoneSpecifies whether whether the probe is enabled/disabled by default.
target_type_id_returnedintegerfalsenoneDefines the return target type value.
  • A probe with target_type 100 is responsible for collecting statistics for an agent.
  • A probe with target_type 200 is responsible for collecting statistics for a monitored server.
  • A probe with target_type 300 is responsible for collecting statistics for a database.
  • A probe with target_type 400 is responsible for collecting statistics for a schema.
  • A probe with target_type 500 is responsible for collecting statistics for a table.
  • A probe with target_type 600 is responsible for collecting statistics for a index.
  • A probe with target_type 700 is responsible for collecting statistics for a sequence.
  • A probe with target_type 800 is responsible for collecting statistics for a function.
  • A probe with target_type 900 is responsible for collecting statistics for a view.

ProbeConfigData

{
  "interval_min": 0,
  "interval_sec": 0,
  "lifetime": 0,
  "enabled": true
}

Properties

NameTypeRequiredRestrictionsDescription
interval_minintegerfalsenoneProbe 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_secintegerfalsenoneProbe 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.
lifetimeintegerfalsenoneProbe history data retention period (in days). That is, 1 <= lifetime <= 365.
enabledbooleanfalsenoneDetermines whether the probe is enabled for the given object.

CopyAgentData

{
  "type": "string",
  "agent_id": 0
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "agent"
agent_idintegerfalsenonenone

CopyServerData

{
  "type": "string",
  "server_id": 0
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "server"
server_idintegerfalsenonenone

CopyDatabaseData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "database"
server_idintegerfalsenonenone
database_namestringfalsenonenone

CopySchemaData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "schema"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone

CopyAlertAgentData

{
  "type": "string",
  "agent_id": 0,
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "agent"
agent_idintegerfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertServerData

{
  "type": "string",
  "server_id": 0,
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "server"
server_idintegerfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertDatabaseData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "database"
server_idintegerfalsenonenone
database_namestringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertSchemaData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "schema"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertTableData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string",
  "table_name": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "table"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone
table_namestringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertIndexData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string",
  "index_name": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "index"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone
index_namestringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertFunctionData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string",
  "function_name": "string",
  "function_arguments": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "function"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone
function_namestringfalsenonenone
function_argumentsstringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

CopyAlertSequenceData

{
  "type": "string",
  "server_id": 0,
  "database_name": "string",
  "schema_name": "string",
  "sequence_name": "string",
  "existing_alert_options": "I"
}

Properties

NameTypeRequiredRestrictionsDescription
typestringfalsenoneValue must be "sequence"
server_idintegerfalsenonenone
database_namestringfalsenonenone
schema_namestringfalsenonenone
sequence_namestringfalsenonenone
existing_alert_optionsstringfalsenoneDetermines 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
PropertyValue
existing_alert_optionsI
existing_alert_optionsR
existing_alert_optionsD

Agent

{
  "id": 0,
  "name": "string",
  "version": "string",
  "active": true,
  "heartbeat_int": 0,
  "alert_blackout": true,
  "owner": "string",
  "team": "string",
  "gid": 0,
  "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:
\

[{
  /* Agent information */
  "id": 1,
  "gid": 0,
  "name": "Postgres Enterprise Manager Host"
  "version": "9.3.0",
  "active": True,
  "heartbeat_int": 30,
  "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

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneIdentity of the pem-agent
namestringfalsenoneDescription (name) of the agent.
versionstringfalsenoneVersion of the pem-agent
activebooleanfalsenoneDetermines whether the agent is active.
An active agent is responsible for collecting the statistics for the host and the monitored server.
heartbeat_intintegerfalsenoneheartbeat interval (in seconds) for the agent.
Specifies how frequently the agent sends the heartbeat status to the PEM database server about itself and the monitoring database server.
alert_blackoutbooleanfalsenoneDetermines whether the alert is blacked out for the agent.
ownerstringfalsenoneUsername of user who installed the agent. This user is called the owner.
teamstringfalsenoneName of the role/user who can see this agent.
A null/empty value indicates all users can see this agent.
gidintegerfalsenoneIdentity of the group
ignore_mnt_points[string]falsenoneUsed to ignore the mount point for disk usage calculation

Agents

[
  {
    "id": 0,
    "name": "string",
    "version": "string",
    "active": true,
    "heartbeat_int": 0,
    "alert_blackout": true,
    "owner": "string",
    "team": "string",
    "gid": 0,
    "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:
\

[{
  /* Agent information */
  "id": 1,
  "gid": 0,
  "name": "Postgres Enterprise Manager Host"
  "version": "9.3.0",
  "active": True,
  "heartbeat_int": 30,
  "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

NameTypeRequiredRestrictionsDescription
idintegertruenoneIdentity of the pem-agent
namestringtruenoneDescription (name) of the agent.
versionstringtruenoneVersion of the pem-agent
activebooleantruenoneDetermines whether the agent is active.
An active agent is responsible for collecting the statistics for the host and the monitored server.
heartbeat_intintegertruenoneheartbeat interval (in seconds) for the agent.
Specifies how frequently the agent sends the heartbeat status to the PEM database server about itself and the monitoring database server.
alert_blackoutbooleantruenoneDetermines whether the alert is blacked out for the agent.
ownerstringtruenoneUsername of user who installed the agent. This user is called the owner.
teamstringtruenoneName of the role/user who can see this agent.
A null/empty value indicates all users can see this agent.
gidintegerfalsenoneIdentity of the group
ignore_mnt_points[string]falsenoneUsed to ignore the mount point for disk usage calculation

Server

{
  "id": 0,
  "name": "string",
  "host": "string",
  "port": 0,
  "database": "string",
  "ssl": 0,
  "serviceid": "string",
  "active": true,
  "alert_blackout": true,
  "owner": 0,
  "team": "string",
  "server_owner": "string",
  "is_remote_monitoring": true,
  "efm_cluster_name": "string",
  "efm_service_name": "string",
  "efm_installation_path": "string",
  "comment": "string",
  "username": "string",
  "gid": 0,
  "db_restriction": "string",
  "role": "string",
  "is_edb": true,
  "agent_id": 0,
  "asb_host": "string",
  "asb_port": 0,
  "asb_username": "string",
  "asb_database": "string",
  "asb_sslmode": "prefer",
  "asb_password": "string",
  "agent_allowtakeover": false,
  "agent_capability_list": [
    "string"
  ],
  "agent_description": "string",
  "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"
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneServer ID.NOTE: This property is not applicable for a POST request.
namestringfalsenoneServer name
hoststringfalsenoneServer host
portintegerfalsenoneServer port
databasestringfalsenoneMaintenance databse
sslintegerfalsenoneSSL mode
serviceidstringfalsenoneServer service ID
activebooleanfalsenoneDetermines whether the server is active.
alert_blackoutbooleanfalsenoneDetermines whether the alerts on the server are blacked out.
ownerintegerfalsenoneID of the owner who registered the server with PEM.
teamstringfalsenoneDefines the role/username who can see server information.
server_ownerstringfalsenoneName of the user who registered the server on the PEM database server.
is_remote_monitoringbooleanfalsenoneDetermines whether this server is being monitored remotely (that is, the monitoring pemAgent does not reside on the same host as the monitored server).
efm_cluster_namestringfalsenoneCluster name of EFM
efm_service_namestringfalsenoneService name of EFM
efm_installation_pathstringfalsenoneInstallation path of EFM
commentstringfalsenoneDescription of the server
usernamestringfalsenoneUsername for connecting the database server
gidintegerfalsenoneID of the server group
db_restrictionstringfalsenoneDatabase restriction SQL clause
rolestringfalsenoneThe role the connection will use
is_edbbooleanfalsenoneIs server an EDB Advanced Server?
agent_idintegerfalsenoneAgent ID bound to the server
asb_hoststringfalsenonePEM database host used by agent while creating PEM connection
asb_portintegerfalsenonePEM database port used by agent while creating PEM connection
asb_usernamestringfalsenonePEM database user name used by agent while creating PEM connection
asb_databasestringfalsenonePEM database to which agent will connect
asb_sslmodestringfalsenonePEM database SSL mode
asb_passwordstringfalsenoneempty string
agent_allowtakeoverbooleanfalsenoneSpecifies whether the server can be taken over by another agent.
agent_capability_list[string]falsenoneArray of agent capabilities
agent_descriptionstringfalsenoneAgent description
fgcolorstringfalsenoneForeground color of server node in browser tree. Default is black( #000000)
bgcolorstringfalsenoneBackground color of server node in browser tree. Default is white( #FFFFFF)
sslcompressionbooleanfalsenoneDetermines whether data sent over SSL should be compressed.
use_ssh_tunnelbooleanfalsenoneDetermines whether to use ssh tunnel.
tunnel_hoststringfalsenoneTunnel host name
tunnel_portintegerfalsenoneTunnel port number
tunnel_usernamestringfalsenoneTunnel username
tunnel_passwordstringfalsenoneTunnel password
tunnel_authenticationbooleanfalsenoneDetermines whether to use tunnel authentication.
tunnel_identity_filestringfalsenoneTunnel identity file used for authentication.
Enumerated Values
PropertyValue
asb_sslmodeprefer
asb_sslmodeallow
asb_sslmodedisable
asb_sslmoderequire
asb_sslmodeverify-ca
asb_sslmodeverify-full

ServerGroupBody

{
  "name": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringfalsenoneServer group name

ServerGroupBodyGet

{
  "id": 0,
  "name": "string",
  "hidden": true
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneServer group id
namestringfalsenoneServer group name
hiddenbooleanfalsenoneDetermines whether Server group is hidden

ServerBody

{
  "name": "string",
  "host": "string",
  "port": 0,
  "database": "string",
  "ssl": 0,
  "serviceid": "string",
  "alert_blackout": true,
  "team": "string",
  "is_remote_monitoring": true,
  "efm_cluster_name": "string",
  "efm_service_name": "string",
  "efm_installation_path": "string",
  "comment": "string",
  "username": "string",
  "gid": 0,
  "hostaddr": "string",
  "db_restriction": "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"
}

Properties

NameTypeRequiredRestrictionsDescription
namestringfalsenoneServer name
hoststringfalsenoneServer host name or address
portintegerfalsenoneServer port
databasestringfalsenoneMaintenance databse
sslintegerfalsenoneSSL mode
serviceidstringfalsenoneServer service ID
alert_blackoutbooleanfalsenoneDetermines whether the alerts on the server are blacked out.
teamstringfalsenoneDefines the role/username who can see server information.
is_remote_monitoringbooleanfalsenoneDetermines whether this server is being monitored remotely (that is, the monitoring pemAgent does not reside on the same host as the monitored server).
efm_cluster_namestringfalsenoneCluster name of EFM
efm_service_namestringfalsenoneService name of EFM
efm_installation_pathstringfalsenoneInstallation path of EFM
commentstringfalsenoneDescription of the server
usernamestringfalsenoneUsername for connecting the database server
gidintegerfalsenoneID of the server group
hostaddrstringfalsenoneServer host address
db_restrictionstringfalsenoneDatabase restriction SQL clause
rolestringfalsenoneThe role the connection will use
agent_idintegerfalsenoneAgent ID bound to the server
asb_hoststringfalsenonePEM database host used by agent while creating PEM connection
asb_portintegerfalsenonePEM database port used by agent while creating PEM connection
asb_usernamestringfalsenonePEM database user name used by agent while creating PEM connection
asb_databasestringfalsenonePEM database to which agent will connect
asb_sslmodestringfalsenonePEM database SSL mode
asb_passwordstringfalsenoneempty string
agent_allowtakeoverbooleanfalsenoneSpecifies whether the server can be taken over by another agent.
fgcolorstringfalsenoneForeground color of server node in browser tree. Default is black( #000000)
bgcolorstringfalsenoneBackground color of server node in browser tree. Default is white( #FFFFFF)
sslcompressionbooleanfalsenoneDetermines whether data sent over SSL should be compressed.
use_ssh_tunnelbooleanfalsenoneDetermines whether to use ssh tunnel.
tunnel_hoststringfalsenoneTunnel host name
tunnel_portintegerfalsenoneTunnel port number
tunnel_usernamestringfalsenoneTunnel username
tunnel_passwordstringfalsenoneTunnel password
tunnel_authenticationbooleanfalsenoneDetermines whether to use tunnel authentication.
tunnel_identity_filestringfalsenoneTunnel identity file used for authentication.
Enumerated Values
PropertyValue
asb_sslmodeprefer
asb_sslmodeallow
asb_sslmodedisable
asb_sslmoderequire
asb_sslmodeverify-ca
asb_sslmodeverify-full

AgentBody

{
  "name": "string",
  "heartbeat_int": 0,
  "alert_blackout": true,
  "team": "string",
  "gid": 0,
  "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:
\

[{
  /* Agent information */
  "id": 1,
  "gid": 0,
  "name": "Postgres Enterprise Manager Host"
  "version": "9.3.0",
  "active": True,
  "heartbeat_int": 30,
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneDescription (name) of the agent.
heartbeat_intintegerfalsenoneheartbeat interval (in seconds) for the agent.
Specifies how frequently the agent sends the heartbeat status to the PEM database server about itself and the monitoring database server.
alert_blackoutbooleanfalsenoneDetermines whether the alert is blacked out for the agent.
teamstringfalsenoneName of the role/user who can see this agent.
A null/empty value indicates all users can see this agent.
gidintegerfalsenoneIdentity of the group
ignore_mnt_points[string]falsenoneUsed to ignore the mount point for disk usage calculation

AgentJobBodyGet

{
  "jobname": "string",
  "jobenabled": true,
  "jobdesc": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
jobnamestringfalsenoneName of the job.
jobenabledbooleanfalsenoneDetermines whether the job is enabled or disabled.
jobdescstringfalsenoneDescription of the job.

AgentJobBody

{
  "jobname": "string",
  "jobenabled": true,
  "jobdesc": "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"
    }
  ],
  "notify": "string",
  "email_group_id": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
jobnamestringfalsenoneName of the job.
jobenabledbooleanfalsenoneDetermines whether the job is enabled or disabled.
jobdescstringfalsenoneDescription of the job.
jsteps[object]falsenoneList of steps for the job.
» jstidintegerfalsenoneID of the step.
» jstjobidintegerfalsenoneID of the job associated with the step.
» jstnamestringfalsenoneName of the step.
» jstdescstringfalsenoneDescription of the step.
» jstenabledbooleanfalsenoneDetermines whether the step is enabled or disabled.
» jstkindbooleanfalsenoneDetermines the kind of the step. True for SQL step, False for Batch step.
» jstcodestringfalsenoneCode or script for the step.
» server_idintegerfalsenoneID of the server associated with the step.
» database_namestringfalsenoneName of the database associated with the step.
» jstonerrorstringfalsenoneSpecifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore').
jschedules[object]falsenoneList of schedules for the job.
» jscidinteger¦nullfalsenoneID of the schedule.
» jscjobidinteger¦nullfalsenoneID of the job associated with the schedule.
» jscnamestringfalsenoneName of the schedule.
» jscdescstringfalsenoneDescription of the schedule.
» jscenabledbooleanfalsenoneDetermines whether the schedule is enabled or disabled.
» jscstartstring(date-time)falsenoneStart date and time of the schedule.
» jscendstring(date-time)falsenoneEnd date and time of the schedule.
» jscweekdays[boolean]falsenoneList of weekdays for the schedule.
» jscmonthdays[boolean]falsenoneList of month days for the schedule.
» jscmonths[boolean]falsenoneList of months for the schedule.
» jschours[boolean]falsenoneList of hours for the schedule.
» jscminutes[boolean]falsenoneList of minutes for the schedule.
» jscexceptions[any]falsenoneList of exceptions for the schedule.
» jsctimezonestringfalsenoneTimezone of the schedule.
notifystringfalsenoneNotification setting for the job.
email_group_idstringfalsenoneID of the email group for notifications.

AgentJobBodyPut

{
  "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

NameTypeRequiredRestrictionsDescription
jobnamestringfalsenoneName of the job.
jobenabledbooleanfalsenoneDetermines whether the job is enabled or disabled.
jobdescstringfalsenoneDescription of the job.
jstepsobjectfalsenonenone
» added[object]falsenoneList of added steps.
»» jstnamestringfalsenoneName of the step.
»» jstdescstringfalsenoneDescription of the step.
»» jstenabledbooleanfalsenoneDetermines whether the step is enabled or disabled.
»» jstkindbooleanfalsenoneDetermines the kind of the step. True for SQL step, False for Batch step.
»» jstcodestringfalsenoneCode or script for the step.
»» server_idintegerfalsenoneID of the server associated with the step.
»» database_namestringfalsenoneName of the database associated with the step.
»» jstonerrorstringfalsenoneSpecifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore').
» changed[object]falsenoneList of changed steps.
»» jstidintegerfalsenoneID of the step.
»» jstnamestringfalsenoneName of the step.
»» jstdescstringfalsenoneDescription of the step.
»» jstenabledbooleanfalsenoneDetermines whether the step is enabled or disabled.
»» jstkindbooleanfalsenoneDetermines the kind of the step. True for SQL step, False for Batch step.
»» jstcodestringfalsenoneCode or script for the step.
»» server_idintegerfalsenoneID of the server associated with the step.
»» database_namestringfalsenoneName of the database associated with the step.
»» jstonerrorstringfalsenoneSpecifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore').
»» jstnextrunstringfalsenonenone
jschedulesobjectfalsenonenone
» added[object]falsenoneList of added schedules.
»» jscnamestringfalsenoneName of the schedule.
»» jscdescstringfalsenoneDescription of the schedule.
»» jscenabledbooleanfalsenoneDetermines whether the schedule is enabled or disabled.
»» jscstartstringfalsenoneStart date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
»» jscendstringfalsenoneEnd date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
»» jscweekdays[any]falsenoneList of weekdays for the schedule.
»» jscmonthdays[any]falsenoneList of month days for the schedule.Note: Here,'32' represents Last Day of the Month
»» jscmonths[any]falsenoneList of months for the schedule.
»» jschours[any]falsenoneList of hours(0-23) for the schedule.
»» jscminutes[any]falsenoneList of minutes(0-59) for the schedule.
»» jscexceptions[object]falsenoneList of exceptions for the schedule.
»»» jexdatestring(date)falsenoneDate of the schedule exception.
»»» jextimestring(time)falsenoneTime of the schedule exception.
»» jsctimezonestringfalsenoneTimezone of the schedule.
» changed[object]falsenoneList of changed schedules.
»» jscidinteger¦nullfalsenoneID of the schedule.
»» jscnamestringfalsenoneName of the schedule.
»» jscdescstringfalsenoneDescription of the schedule.
»» jscenabledbooleanfalsenoneDetermines whether the schedule is enabled or disabled.
»» jscstartstringfalsenoneStart date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
»» jscendstringfalsenoneEnd date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
»» jscweekdays[any]falsenoneList of weekdays for the schedule.
»» jscmonthdays[any]falsenoneList of month days for the schedule.Note: Here,'32' represents Last Day of the Month
»» jscmonths[any]falsenoneList of months for the schedule.
»» jschours[any]falsenoneList of hours(0-23) for the schedule.
»» jscminutes[any]falsenoneList of minutes(0-59) for the schedule.
»» jscexceptions[object]falsenoneList of exceptions for the schedule.
»»» jexdatestring(date)falsenoneDate of the schedule exception.
»»» jextimestring(time)falsenoneTime of the schedule exception.
»» jsctimezonestringfalsenoneTimezone of the schedule.
notifystringfalsenoneNotification setting for the job.
email_group_idstringfalsenoneID of the email group for notifications.
Enumerated Values
PropertyValue
jstonerrorf
jstonerrors
jstonerrori
jstonerrorf
jstonerrors
jstonerrori
jscweekdaysMonday
jscweekdaysTuesday
jscweekdaysWednesday
jscweekdaysThursday
jscweekdaysFriday
jscweekdaysSaturday
jscweekdaysSunday
jscmonthdays1
jscmonthdays2
jscmonthdays3
jscmonthdays4
jscmonthdays5
jscmonthdays6
jscmonthdays7
jscmonthdays8
jscmonthdays9
jscmonthdays10
jscmonthdays11
jscmonthdays12
jscmonthdays13
jscmonthdays14
jscmonthdays15
jscmonthdays16
jscmonthdays17
jscmonthdays18
jscmonthdays19
jscmonthdays20
jscmonthdays21
jscmonthdays22
jscmonthdays23
jscmonthdays24
jscmonthdays25
jscmonthdays26
jscmonthdays27
jscmonthdays28
jscmonthdays29
jscmonthdays30
jscmonthdays31
jscmonthdays32
jscmonthsJanuary
jscmonthsFebruary
jscmonthsMarch
jscmonthsApril
jscmonthsMay
jscmonthsJune
jscmonthsJuly
jscmonthsAugust
jscmonthsSeptember
jscmonthsOctober
jscmonthsNovember
jscmonthsDecember
jschours0
jschours1
jschours2
jschours3
jschours4
jschours5
jschours6
jschours7
jschours8
jschours9
jschours10
jschours22
jscminutes0
jscminutes1
jscminutes2
jscminutes3
jscminutes4
jscminutes5
jscminutes6
jscminutes7
jscminutes8
jscminutes9
jscminutes10
jscminutes31
jscminutes32
jscminutes33
jscminutes34
jscminutes35
jscminutes36
jscminutes37
jscminutes38
jscminutes39
jscminutes51
jscminutes52
jscminutes53
jscminutes54
jscminutes55
jscminutes56
jscminutes57
jscminutes58
jscminutes59
jsctimezoneAsia/Calcutta
jsctimezoneCanada/Pacific
jsctimezoneAsia/Tokyo
jsctimezoneetc
jscweekdaysMonday
jscweekdaysTuesday
jscweekdaysWednesday
jscweekdaysThursday
jscweekdaysFriday
jscweekdaysSaturday
jscweekdaysSunday
jscmonthdays1
jscmonthdays2
jscmonthdays3
jscmonthdays4
jscmonthdays5
jscmonthdays6
jscmonthdays7
jscmonthdays8
jscmonthdays9
jscmonthdays10
jscmonthdays11
jscmonthdays12
jscmonthdays13
jscmonthdays14
jscmonthdays15
jscmonthdays16
jscmonthdays17
jscmonthdays18
jscmonthdays19
jscmonthdays20
jscmonthdays21
jscmonthdays22
jscmonthdays23
jscmonthdays24
jscmonthdays25
jscmonthdays26
jscmonthdays27
jscmonthdays28
jscmonthdays29
jscmonthdays30
jscmonthdays31
jscmonthdays32
jscmonthsJanuary
jscmonthsFebruary
jscmonthsMarch
jscmonthsApril
jscmonthsMay
jscmonthsJune
jscmonthsJuly
jscmonthsAugust
jscmonthsSeptember
jscmonthsOctober
jscmonthsNovember
jscmonthsDecember
jschours0
jschours1
jschours2
jschours3
jschours4
jschours5
jschours6
jschours7
jschours8
jschours9
jschours10
jschours22
jscminutes0
jscminutes1
jscminutes2
jscminutes3
jscminutes4
jscminutes5
jscminutes6
jscminutes7
jscminutes8
jscminutes9
jscminutes10
jscminutes31
jscminutes32
jscminutes33
jscminutes34
jscminutes35
jscminutes36
jscminutes37
jscminutes38
jscminutes39
jscminutes51
jscminutes52
jscminutes53
jscminutes54
jscminutes55
jscminutes56
jscminutes57
jscminutes58
jscminutes59
jsctimezoneAsia/Calcutta
jsctimezoneCanada/Pacific
jsctimezoneAsia/Tokyo
jsctimezoneetc
notifyDEFAULT
notifyON_FAILURE
notifyALWAYS
notifyNEVER

AgentJobBodyPost

{
  "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

NameTypeRequiredRestrictionsDescription
jobnamestringfalsenoneName of the job.
jobenabledbooleanfalsenoneDetermines whether the job is enabled or disabled.
jobdescstringfalsenoneDescription of the job.
jsteps[object]falsenoneList of steps for the job.
» jstnamestringfalsenoneName of the step.
» jstdescstringfalsenoneDescription of the step.
» jstenabledbooleanfalsenoneDetermines whether the step is enabled or disabled.
» jstkindbooleanfalsenoneDetermines the kind of the step. True for SQL step, False for Batch step.
» jstcodestringfalsenoneCode or script for the step.
» server_idintegerfalsenoneID of the server associated with the step.
» database_namestringfalsenoneName of the database associated with the step.
» jstonerrorstringfalsenoneSpecifies the behavior of agent if it encounters an error while executing the step('Fail', 'Success', 'Ignore').
jschedules[object]falsenoneList of schedules for the job.
» jscnamestringfalsenoneName of the schedule.
» jscdescstringfalsenoneDescription of the schedule.
» jscenabledbooleanfalsenoneDetermines whether the schedule is enabled or disabled.
» jscstartstringfalsenoneStart date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
» jscendstringfalsenoneEnd date and time of the schedule(YYYY-MM-DD HH:mm ±HH:mm).
» jscweekdays[any]falsenoneList of weekdays for the schedule.
» jscmonthdays[any]falsenoneList of month days for the schedule.Note: Here,'32' represents Last Day of the Month
» jscmonths[any]falsenoneList of months for the schedule.
» jschours[any]falsenoneList of hours(0-23) for the schedule.
» jscminutes[any]falsenoneList of minutes(0-59) for the schedule.
» jscexceptions[object]falsenoneList of exceptions for the schedule.
»» jexdatestring(date)falsenoneDate of the schedule exception.
»» jextimestring(time)falsenoneTime of the schedule exception.
» jsctimezonestringfalsenoneTimezone of the schedule.
notifystringfalsenoneNotification setting for the job.
email_group_idstringfalsenoneID of the email group for notifications.
Enumerated Values
PropertyValue
jstonerrorf
jstonerrors
jstonerrori
jscweekdaysMonday
jscweekdaysTuesday
jscweekdaysWednesday
jscweekdaysThursday
jscweekdaysFriday
jscweekdaysSaturday
jscweekdaysSunday
jscmonthdays1
jscmonthdays2
jscmonthdays3
jscmonthdays4
jscmonthdays5
jscmonthdays6
jscmonthdays7
jscmonthdays8
jscmonthdays9
jscmonthdays10
jscmonthdays11
jscmonthdays12
jscmonthdays13
jscmonthdays14
jscmonthdays15
jscmonthdays16
jscmonthdays17
jscmonthdays18
jscmonthdays19
jscmonthdays20
jscmonthdays21
jscmonthdays22
jscmonthdays23
jscmonthdays24
jscmonthdays25
jscmonthdays26
jscmonthdays27
jscmonthdays28
jscmonthdays29
jscmonthdays30
jscmonthdays31
jscmonthdays32
jscmonthsJanuary
jscmonthsFebruary
jscmonthsMarch
jscmonthsApril
jscmonthsMay
jscmonthsJune
jscmonthsJuly
jscmonthsAugust
jscmonthsSeptember
jscmonthsOctober
jscmonthsNovember
jscmonthsDecember
jschours0
jschours1
jschours2
jschours3
jschours4
jschours5
jschours6
jschours7
jschours8
jschours9
jschours10
jschours22
jscminutes0
jscminutes1
jscminutes2
jscminutes3
jscminutes4
jscminutes5
jscminutes6
jscminutes7
jscminutes8
jscminutes9
jscminutes10
jscminutes31
jscminutes32
jscminutes33
jscminutes34
jscminutes35
jscminutes36
jscminutes37
jscminutes38
jscminutes39
jscminutes51
jscminutes52
jscminutes53
jscminutes54
jscminutes55
jscminutes56
jscminutes57
jscminutes58
jscminutes59
jsctimezoneAsia/Calcutta
jsctimezoneCanada/Pacific
jsctimezoneAsia/Tokyo
jsctimezoneetc
notifyDEFAULT
notifyON_FAILURE
notifyALWAYS
notifyNEVER

Database

{
  "database_name": "string",
  "connections_allowed": true,
  "system_database": true,
  "recorded_time": "2019-08-24T14:15:22Z",
  "encoding": "string",
  "server_id": 0
}

Properties

NameTypeRequiredRestrictionsDescription
database_namestringfalsenoneDatabase name
connections_allowedbooleanfalsenoneDetermines whether a connection to the database is allowed.
system_databasebooleanfalsenoneDetermines whether the database is a system database.
recorded_timestring(date-time)falsenoneSpecifies when the database was first detected by the PEM agent.
encodingstringfalsenoneDatabase encoding
server_idintegerfalsenoneServer ID of database

Schema

{
  "schema_name": "string",
  "database_name": "string",
  "server_id": 0,
  "recorded_time": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
schema_namestringfalsenoneSchema name
database_namestringfalsenoneDatabase name of schema
server_idintegerfalsenoneServer ID schema
recorded_timestring(date-time)falsenoneSpecifies when schema was first detected by PEM agent.

Table

{
  "table_name": "string",
  "schema_name": "string",
  "database_name": "string",
  "server_id": 0,
  "has_primary_key": true,
  "recorded_time": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
table_namestringfalsenoneTable name
schema_namestringfalsenoneSchema name
database_namestringfalsenoneDatabase name
server_idintegerfalsenoneServer ID
has_primary_keybooleanfalsenoneDetermines whether table has a primary key.
recorded_timestringfalsenoneSpecifies when table was first detected by the PEM agent.

Index

{
  "index_name": "string",
  "ind_keys": [
    0
  ],
  "table_name": "string",
  "schema_name": "string",
  "database_name": "string",
  "server_id": 0,
  "recorded_time": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
index_namestringfalsenoneIndex name
ind_keys[integer]falsenoneIndexed column positions in table
table_namestringfalsenoneTable name
schema_namestringfalsenoneSchema
database_namestringfalsenoneDatabase name
server_idintegerfalsenoneServer ID
recorded_timestringfalsenoneSpecifies when index was first detected by PEM agent.

Sequence

{
  "sequence_name": "string",
  "schema_name": "string",
  "database_name": "string",
  "server_id": 0,
  "recorded_time": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequiredRestrictionsDescription
sequence_namestringfalsenoneSequence name
schema_namestringfalsenoneSchema name
database_namestringfalsenoneDatabase name
server_idintegerfalsenoneServer ID
recorded_timestring(date-time)falsenoneSpecifies when sequence was first detected by PEM agent.

Function

{
  "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

NameTypeRequiredRestrictionsDescription
function_namestringfalsenoneFunction name
function_typestringfalsenoneFunction type
return_typestringfalsenoneFunction return type
arg_types[string]falsenoneFunction argument types
function_binarystringfalsenonenone
extension_namestringfalsenonenone
package_namestringfalsenoneFunction package name
schema_namestringfalsenoneFunction schema
database_namestringfalsenoneFunction database name
server_idintegerfalsenoneFunction server id
recorded_timestring(date-time)falsenoneSpecifies when function was first detected by PEM agent.

View

{
  "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

NameTypeRequiredRestrictionsDescription
view_namestringfalsenoneView name
view_typestringfalsenoneView type
ispopulatedbooleanfalsenoneDetermines whether the view is populated.
view_ownerstringfalsenoneView owner
definitionstringfalsenoneView definition
tablespace_namestringfalsenoneView tablespace
schema_namestringfalsenoneView schema
database_namestringfalsenoneView database
server_idintegerfalsenoneView server ID
recorded_timestringfalsenoneSpecifies when view was first detected by PEM agent.

Webhook

{
  "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
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneWebhook ID
namestringfalsenoneWebhook name
urlstringfalsenoneWebhook URL
enabledbooleanfalsenoneDetermines whether the webhook is enabled.
methodstringfalsenoneRequest method
http_headers[WebhookGetHTTPHeaders]falsenoneList of the HTTP header key/value pairs to be used by the webhook
payload_templatestringfalsenonePayload template. Below is payload example for slack.
low_alertbooleanfalsenoneDetermines whether the low alert is enabled.
med_alertbooleanfalsenoneDetermines whether the medium alert is enabled.
high_alertbooleanfalsenoneDetermines whether the high alert is enabled.
cleared_alertbooleanfalsenoneDetermines whether the cleared alert is enabled.
Enumerated Values
PropertyValue
methodPOST
methodPUT

WebhookPostData

{
  "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
}

Properties

NameTypeRequiredRestrictionsDescription
namestringfalsenoneWebhook name
urlstringfalsenoneWebhook URL
enabledbooleanfalsenoneDetermines whether the webhook is enabled.
methodstringfalsenoneRequest method
http_headers[WebhookHTTPHeaders]falsenoneList of the HTTP header key/value pairs to be used by the webhook
payload_templatestringfalsenonePayload template
low_alertbooleanfalsenoneDetermines whether the low alert is enabled.
med_alertbooleanfalsenoneDetermines whether the medium alert is enabled.
high_alertbooleanfalsenoneDetermines whether the high alert is enabled.
cleared_alertbooleanfalsenoneDetermines whether the cleared alert is enabled.
Enumerated Values
PropertyValue
methodPOST
methodPUT

WebhookPutData

{
  "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_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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneWebhook name
urlstringfalsenoneWebhook URL
enabledbooleanfalsenoneDetermines whether the webhook is enabled.
methodstringfalsenoneRequest method
http_headersobjectfalsenonenone
» added[WebhookHTTPHeaders]falsenoneList of the HTTP header key/value pairs to be added
» changed[WebhookGetHTTPHeaders]falsenoneList of the HTTP header key/value pairs to be updated
» deleted[object]falsenoneList of the HTTP header IDs to be deleted
»» http_header_idintegerfalsenoneID of the HTTP header
payload_templatestringfalsenonePayload template. Below is payload example for slack.
low_alertbooleanfalsenoneDetermines whether the low alert is enabled.
med_alertbooleanfalsenoneDetermines whether the medium alert is enabled.
high_alertbooleanfalsenoneDetermines whether the high alert is enabled.
cleared_alertbooleanfalsenoneDetermines whether the cleared alert is enabled.
Enumerated Values
PropertyValue
methodPOST
methodPUT

WebhookGetHTTPHeaders

{
  "http_header_id": 0,
  "http_header_key": "string",
  "http_header_value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
http_header_idintegerfalsenoneID of the HTTP header
http_header_keystringfalsenoneName of the HTTP header key
http_header_valuestringfalsenoneName of the HTTP header key

WebhookHTTPHeaders

{
  "http_header_key": "string",
  "http_header_value": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
http_header_keystringfalsenoneName of the HTTP header key
http_header_valuestringfalsenoneName of the HTTP header key

EmailGroups

{
  "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

NameTypeRequiredRestrictionsDescription
idintegerfalsenoneEmail group ID
oidintegerfalsenoneEmail group options ID
gidintegerfalsenoneEmail group ID
namestringfalsenoneEmail group name
to_addrstringfalsenoneEmail group options receiver address
cc_addrstringfalsenoneEmail group options CC address
bcc_addrstringfalsenoneEmail group options BCC address
from_addrstringfalsenoneEmail group options sender address
reply_to_addrstringfalsenoneEmail group options reply to address
subject_prefixstringfalsenoneEmail group options subject prefix
from_timestringfalsenoneEmail group options from time to select time range for members
to_timestringfalsenoneEmail group options to time to select time range for members

EmailGroupsPostData

{
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneEmail group name
options[EmailGroupOptions]falsenoneList of the email group options to be used by the email group

EmailGroupsPutData

{
  "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

NameTypeRequiredRestrictionsDescription
namestringfalsenoneEmail group name
optionsobjectfalsenonenone
» added[EmailGroupOptions]falsenoneEmail group options to be added
» changed[EmailGroupOptionsChanged]falsenoneEmail group options to be updated.
» deleted[object]falsenoneList of the HTTP header IDs to be deleted
»» oidintegerfalsenoneEmail group options ID

EmailGroupOptions

{
  "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

NameTypeRequiredRestrictionsDescription
to_addrstringfalsenoneEmail group options receiver address
cc_addrstringfalsenoneEmail group options CC address
bcc_addrstringfalsenoneEmail group options BCC address
from_addrstringfalsenoneEmail group options sender address
reply_to_addrstringfalsenoneEmail group options reply to address
subject_prefixstringfalsenoneEmail group options subject prefix
from_timestringfalsenoneEmail group options from time to select time range for members
to_timestringfalsenoneEmail group options to time to select time range for members

EmailGroupOptionsChanged

{
  "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

NameTypeRequiredRestrictionsDescription
oidintegerfalsenoneEmail group options ID
to_addrstringfalsenoneEmail group options receiver address
cc_addrstringfalsenoneEmail group options CC address
bcc_addrstringfalsenoneEmail group options BCC address
from_addrstringfalsenoneEmail group options sender address
reply_to_addrstringfalsenoneEmail group options reply to address
subject_prefixstringfalsenoneEmail group options subject prefix
from_timestringfalsenoneEmail group options from time to select time range for members
to_timestringfalsenoneEmail group options to time to select time range for members

ExcludeDatabases

{
  "server_id": 0,
  "name": "string",
  "exclude_databases": [
    "string"
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
server_idintegerfalsenoneServer ID
namestringfalsenoneServer name
exclude_databases[string]falsenoneExclude database names (comma separated)

ExcludeDatabasesPutData

{
  "exclude_databases": [
    "string"
  ]
}

Properties

NameTypeRequiredRestrictionsDescription
exclude_databases[string]falsenoneExclude database names (comma separated)
← Prev

EDB Postgres Enterprise Manager REST APIs v11.0: Include/Exclude Database Monitoring

↑ Up

EDB Postgres Enterprise Manager REST APIs v11.0

Next →

EDB Postgres Enterprise Manager REST APIs v10.0