EDB Postgres Enterprise Manager REST APIs v7.0: Alerts Status v10.2

get__alert_status_

Code samples

GET /alert/status/

Gets the current status of all the alerts.

Parameters

NameInTypeRequiredDescription
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
[
  {
    "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"
      ]
    ]
  }
]

Responses

StatusMeaningDescriptionSchema
200OKSuccessful responseInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[AlertStatus]falsenonenone
» 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
Info

This operation does not require authentication

get__alert_status_{since}

Code samples

GET /alert/status/{since}

Gets the list of alert state changes after the given time.

Parameters

NameInTypeRequiredDescription
sincepathnumbertrueUnix timeline
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
{
  "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"
    ]
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKSuccessful responseAlertStatus
Info

This operation does not require authentication