Alerting API
Last updated
Last updated
For more details, please refer to the Alerting feature.
To use the Alerting API, it's necessary to generate an access token.
GET
https://<<platform-server>>/ds-api/alerting/{pg-instance}/status
Display Instance Alerting Status
pg-instance*
String
Instance name in Datasentinel: <<server_name>>@<<pg_name>>
user-token*
String
Generated Access Token
Response
If instance alerting is inactive, the reason field clarifies the cause. Several possibilities exist:
Global alerting is turned off on the Datasentinel platform.
An instance-specific silence is in effect.
A silence is active, covering the instance through its filters.
No corresponding alerting rule has been identified.
PATCH
https://<<platform-server>>/ds-api/alerting/{pg-instance}/enable
Enable Instance Alerting
pg-instance*
String
Instance name in Datasentinel: <<server_name>>@<<pg_name>>
user-token*
String
Generated Access Token
Response
Several reasons could contribute to this:
Global alerting is turned off on the Datasentinel platform.
A silence is active, covering the instance through its filters.
No corresponding alerting rule has been identified.
PATCH
https://<<platform-server>>/ds-api/alerting/{pg-instance}/disable
Disable Instance Alerting
pg-instance*
String
Instance name in Datasentinel: <<server_name>>@<<pg_name>>
user-token*
String
Generated Access Token
Response
GET
https://<<platform-server>>/ds-api/alerting/{pg-instance}/problems
Display Instance Problems
pg-instance*
String
Instance name in Datasentinel: <<server_name>>@<<pg_name>>
user-token*
String
Generated Access Token
Response
POST
https://<<platform-server>>/ds-api/alerting/{pg-instance}/problems
Create Custom Instance Problem
pg-instance*
String
Instance name in Datasentinel: <<server_name>>@<<pg_name>>
user-token*
String
Generated Access Token
Response