EDB Postgres Enterprise Manager REST APIs v17.0#
NOTE:
EDB Postgres Enterprise Manager is referred to as PEM in this documentation.
Because PEM uses self-certified SSL certificates, you may encounter an error such as ‘SSL certificate problem: self signed certificate’. You may need to use the ‘insecure’ connection to connect to the server.
PEM exposes end-points (REST APIs) for the following operations:
Retrieval of the objects retrieved from the monitored server and agents.
Create, Retrieve, Update, and Delete (CRUD) operations for probes.
Retrieval of the statistics/metrics data (including the historical data) collected by different probes.
Create, Retrieve, Update, and Delete (CRUD) operations for alerts.
Create, Retrieve, Update, and Delete (CRUD) operations for the email group used by the alerts mechanism.
Create, Retrieve, Update, and Delete (CRUD) operations for alert templates used by the alerts.
Retrieve and Update of probe configuration.
Copy the agent/server/database/schema level probe configurations to other objects at the same level or lower level objects.
Copy the alert configuration of one object to other objects.
Retrieve and Update the PEM-server configurations.
v17 enhancements:
Adds the ``/blackout/`` endpoint for managing alert blackouts as first-class objects (CRUD).
Adds name-based filtering support for object listing endpoints via ``name`` and ``name_contains`` query parameters.
Base URLs:
Email: EnterpriseDB Web: EnterpriseDB License: Limited Use Software License Agreement
- Object
- get_server_group
- post_server_group
- get_server_group{group_id}
- put_server_group{group_id}
- delete_server_group{group_id}
- get_agent
- get_agent{agent_id}
- put_agent{agent_id}
- delete_agent{agent_id}
- get_server
- post_server
- get_server{server_id}
- put_server{server_id}
- delete_server{server_id}
- get_server{sid}database
- get_server{sid}database{db_name}
- get_server{sid}database{db_name}schema
- get_server{sid}database{db_name}schema{schema_name}
- get_server{sid}database{db_name}schema{schema_name}table
- get_server{sid}database{db_name}schema{schema_name}table{table_name}
- get_server{sid}database{db_name}schema{schema_name}index
- get_server{sid}database{db_name}schema{schema_name}index{index_name}
- get_server{sid}database{db_name}schema{schema_name}sequence
- get_server{sid}database{db_name}schema{schema_name}sequence{sequence_name}
- get_server{sid}database{db_name}schema{schema_name}view
- get_server{sid}database{db_name}schema{schema_name}view{view_name}
- get_server{sid}database{db_name}schema{schema_name}function
- get_server{sid}database{db_name}schema{schema_name}function{function_name}
- Profiles
- get_profiles
- post_profiles
- get_profiles{profile_id}
- put_profiles{profile_id}
- delete_profiles{profile_id}
- get_profiles{profile_id}_assigned
- get_profiles{profile_id}_draft
- delete_profiles{profile_id}_rollback
- post_profiles{profile_id}_publish
- post_profiles{source_id}_clone
- delete_profiles{profile_id}_{new_profile_id}
- post_profile_export
- post_profile_import
- Blackout
- Monitored Object Status
- Agent Job
- Alerts History
- Alerts Status
- Alerts
- get_alert_config_global
- post_alert_config_global
- get_alert_config_global{alert_id}
- put_alert_config_global{alert_id}
- delete_alert_config_global{alert_id}
- get_alert_config_agent{agent_id}
- post_alert_config_agent{agent_id}
- get_alert_config_agent{agent_id}_{alert_id}
- put_alert_config_agent{agent_id}_{alert_id}
- delete_alert_config_agent{agent_id}_{alert_id}
- get_alert_config_server{server_id}
- post_alert_config_server{server_id}
- get_alert_config_server{server_id}_{alert_id}
- put_alert_config_server{server_id}_{alert_id}
- delete_alert_config_server{server_id}_{alert_id}
- get_alert_config_server{server_id}database{database_name}
- post_alert_config_server{server_id}database{database_name}
- get_alert_config_server{server_id}database{database_name}_{alert_id}
- put_alert_config_server{server_id}database{database_name}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}_{alert_id}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}
- post_alert_config_server{server_id}database{database_name}schema{schema_name}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}
- put_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}schema{schema_name}_{alert_id}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}
- post_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}
- put_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{alert_id}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}
- post_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}
- put_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{alert_id}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}
- post_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}
- put_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{alert_id}
- get_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_
- post_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_
- get_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}
- put_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}
- delete_alert_config_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}_{alert_id}
- Copy Alert
- post_alert_copy_agent{agent_id}
- post_alert_copy_server{server_id}
- post_alert_copy_server{server_id}database{database_name}
- post_alert_copy_server{server_id}database{database_name}schema{schema_name}
- post_alert_copy_server{server_id}database{database_name}schema{schema_name}table{table_name}
- post_alert_copy_server{server_id}database{database_name}schema{schema_name}index{index_name}
- post_alert_copy_server{server_id}database{database_name}schema{schema_name}function{function_name}args{function_arguments}
- post_alert_copy_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}
- Alert template
- Export Custom Alert Templates
- Import Custom Alert Templates
- Export Custom Charts
- Import Custom Charts
- Export Custom Dashboards
- Import Custom Dashboards
- Custom Probe
- Export Custom Probes
- Import Custom Probes
- Probe Configuration
- get_probe_config_agent{agent_id}
- get_probe_config_server{server_id}
- get_probe_config_server{server_id}_{probe_id}
- put_probe_config_server{server_id}_{probe_id}
- get_probe_config_server{server_id}database{database_name}
- get_probe_config_server{server_id}database{database_name}_{probe_id}
- put_probe_config_server{server_id}database{database_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}_{probe_id}
- put_probe_config_server{server_id}database{database_name}schema{schema_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}table{table_name}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}table{table_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}index{index_name}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}index{index_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}function{function_name}_
- get_probe_config_server{server_id}database{database_name}schema{schema_name}function{function_name}_{probe_id}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}view{view_name}
- get_probe_config_server{server_id}database{database_name}schema{schema_name}view{view_name}_{probe_id}
- Copy Probe
- Probe data
- get_probe_data_agent{agent_id}_{probe_id}
- get_probe_data_server{server_id}_{probe_id}
- get_probe_data_server{server_id}database{database_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}table{table_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}index{index_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}view{view_name}_{probe_id}
- get_probe_data_server{server_id}database{database_name}schema{schema_name}function{function_name}_{probe_id}
- get_probe{probe_id}data
- get_probe{internal_name}data
- Probe history
- get_probe_history_agent{agent_id}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}table{table_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}index{index_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}view{view_name}from{start_time}to{end_time}_{probe_id}
- get_probe_history_server{server_id}database{database_name}schema{schema_name}function{function_name}from{start_time}to{end_time}_{probe_id}
- get_probe{probe_id}history_from{start_time}to{end_time}
- get_probe{internal_name}history_from{start_time}to{end_time}
- Webhook
- Email Groups
- >-
- Schemas
- Profile
- ProfileDraft
- ProfileSummary
- ProbeConfig
- ProbeConfigUpsert
- ProbeConfigsUpdateOnly
- AlertChange
- AlertDeleteRef
- AlertConfigsDelta
- DeleteAndReassignPayload
- ProfileAssignmentDetails
- AlertPayload
- Alert
- AlertParams
- AlertTemplateParams
- ProbeDependencyParams
- AlternateServerProbeCode
- DeletedAlternateServerProbeCode
- ProbeColumn
- ChartExportTemplate
- DashboardExportTemplate
- CustomDashboardExportData
- CustomDashboardExportResponseData
- CustomDashboardImportPostData
- CustomChartExportData
- CustomChartExportResponseData
- CustomChartImportPostData
- AlertImportExportTemplate
- CustomAlertTemplateExportData
- CustomAlertTemplateExportResponseData
- CustomAlertTemplateImportPostData
- AlertTemplate
- AlertTemplatePost
- AlertTemplatePut
- AlertHistory
- ServerStatus
- AgentStatus
- AlertStatus
- CustomProbes
- CustomProbeExportData
- CustomProbeImportData
- CustomProbeImportPostData
- CustomProbePostData
- CustomProbePutData
- Probes
- ProbeConfigData
- CopyAgentData
- CopyServerData
- CopyDatabaseData
- CopySchemaData
- CopyAlertAgentData
- CopyAlertServerData
- CopyAlertDatabaseData
- CopyAlertSchemaData
- CopyAlertTableData
- CopyAlertIndexData
- CopyAlertFunctionData
- CopyAlertSequenceData
- Agent
- Agents
- Server
- ServerGroupBody
- ServerGroupBodyGet
- ServerBody
- ServerBodyUpdate
- AgentBody
- AgentJobBodyGet
- AgentJobBody
- AgentJobBodyPut
- AgentJobBodyPost
- Database
- Schema
- Table
- Index
- Sequence
- Function
- View
- Webhook
- WebhookPostData
- WebhookPutData
- WebhookGetHTTPHeaders
- WebhookHTTPHeaders
- EmailGroups
- EmailGroupsPostData
- EmailGroupsPutData
- EmailGroupOptions
- EmailGroupOptionsChanged
- ExcludeDatabases
- ExcludeDatabasesPutData
- Blackout
- BlackoutHistory
- BlackoutWarning
- ObjectBlackoutStatus
- ObjectBlackoutToggleResult