EDB Postgres Enterprise Manager REST APIs v2.0: Alert template v10.2

`get__alert_template_`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v2/alert/template/ \
  -H 'Accept: application/json' \
  -H 'X-Auth-Token: string'

import requests
headers = {
  'Accept': 'application/json',
  'X-Auth-Token': 'string'
}

r = requests.get('https://PEM-SERVER-IP/api/v2/alert/template/', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v2/alert/template/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/template/

Gets Alert templates.

Parameters

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

[
  {
    "id": 0,
    "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": true,
    "is_auto_create": true,
    "thresholds": [
      0
    ],
    "operator": ">",
    "high_threshold_value": "string",
    "medium_threshold_value": "string",
    "low_threshold_value": "string",
    "info_sql": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[AlertTemplate]	false	none	none
» id	integer	false	none	Identifier for the alert template. NOTE: It is not applicable while creating the alert template.
» name	string	false	none	Name of the alert template. NOTE: It is a mandatory parameter for the POST request.
» description	string	false	none	Description about the alert template. NOTE: It is a mandatory parameter for the POST request.
» default_history_retention	integer	false	none	Defines the history retention period in days for this type of alerts. NOTE: It is a mandatory parameter for the POST request.
» object_type	integer	false	none	Defines the type of the object on which this alert template is applicable to. System wide alert template will be 50. An alert template applicable to an agent will be 100. An alert template applicable to a managed server will be 200. An alert template applicable to a database for a particular monitored server will be 300. An alert template applicable to a schema on a particular database for the managed server will be 400. An alert template applicable to a table on a particular schema for the database on a monitored server will be 500. An alert template applicable to an index on a particular schema for the database on a monitored server will be 600. An alert template applicable to a sequence on a particular schema for the database on a monitored server will be 700. An alert template applicable to a function on a particular schema for the database on a monitored server will be 800. NOTE: It is a mandatory parameter for the POST request.
» sql	string	false	none	SQL query, possibly parameterized, to get a numeric indicating threshold reached. NOTE: It is a mandatory parameter for the POST request.
» applicable_on_server	string	false	none	Template is applicable on which type of monitored server. Possible values are ALL, POSTGRES_SERVER, ADVANCED_SERVER. NOTE: It is a mandatory parameter for the POST request.
» default_check_frequency	integer	false	none	Defines how frequently to check for the alert defined from this template (in minutes). NOTE: It is a mandatory parameter for the POST request.
» threshold_unit	string	false	none	Unit in which threshold is calculated; purely for GUI, like MB/kB/seconds/days/...
» is_system_template	boolean	false	none	Defines whether the given template is system defined or user defined. NOTE: It is not applicable for the the POST/PUT requests.
» is_auto_create	boolean	false	none	Whether alert should be created as soon as agent or server is added to pem.
» thresholds	[number]	false	none	Default threshold values. Values in the thresholds array must be in the sorted order based on the operator.
» operator	string	false	none	Operator to compare threshold values.
» high_threshold_value	string	false	none	High threshold value.
» medium_threshold_value	string	false	none	Medium threshold value.
» low_threshold_value	string	false	none	Low threshold value.
» info_sql	string	false	none	Specify the SQL query that will provide the detailed information about that alert on Dashboard.

Enumerated Values

Property	Value
applicable_on_server	ALL
applicable_on_server	POSTGRES_SERVER
applicable_on_server	ADVANCED_SERVER
operator	>
operator	<

Info

This operation does not require authentication

`post__alert_template_`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X POST https://PEM-SERVER-IP/api/v2/alert/template/ \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: string'

import requests
headers = {
  'Content-Type': 'application/json',
  'X-Auth-Token': 'string'
}

r = requests.post('https://PEM-SERVER-IP/api/v2/alert/template/', headers = headers)

print(r.json())

const inputBody = '{
  "id": 0,
  "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": true,
  "is_auto_create": true,
  "thresholds": [
    0
  ],
  "operator": ">",
  "high_threshold_value": "string",
  "medium_threshold_value": "string",
  "low_threshold_value": "string",
  "info_sql": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v2/alert/template/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /alert/template/

Create Alert template.

Body parameter

{
  "id": 0,
  "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": true,
  "is_auto_create": true,
  "thresholds": [
    0
  ],
  "operator": ">",
  "high_threshold_value": "string",
  "medium_threshold_value": "string",
  "low_threshold_value": "string",
  "info_sql": "string"
}

Parameters

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	Token of authorization
body	body	AlertTemplate	true	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Status 200	None

Response Schema

Info

This operation does not require authentication

`get__alert_template_{id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v2/alert/template/{id} \
  -H 'Accept: application/json' \
  -H 'X-Auth-Token: string'

import requests
headers = {
  'Accept': 'application/json',
  'X-Auth-Token': 'string'
}

r = requests.get('https://PEM-SERVER-IP/api/v2/alert/template/{id}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v2/alert/template/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /alert/template/{id}

Gets Alert tenplate idetified by the id.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Alert Template ID
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

{
  "id": 0,
  "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": true,
  "is_auto_create": true,
  "thresholds": [
    0
  ],
  "operator": ">",
  "high_threshold_value": "string",
  "medium_threshold_value": "string",
  "low_threshold_value": "string",
  "info_sql": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	AlertTemplate

Info

This operation does not require authentication

`put__alert_template_{id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v2/alert/template/{id} \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: string'

import requests
headers = {
  'Content-Type': 'application/json',
  'X-Auth-Token': 'string'
}

r = requests.put('https://PEM-SERVER-IP/api/v2/alert/template/{id}', headers = headers)

print(r.json())

const inputBody = '{
  "id": 0,
  "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": true,
  "is_auto_create": true,
  "thresholds": [
    0
  ],
  "operator": ">",
  "high_threshold_value": "string",
  "medium_threshold_value": "string",
  "low_threshold_value": "string",
  "info_sql": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v2/alert/template/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /alert/template/{id}

Update Alert template.

Body parameter

{
  "id": 0,
  "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": true,
  "is_auto_create": true,
  "thresholds": [
    0
  ],
  "operator": ">",
  "high_threshold_value": "string",
  "medium_threshold_value": "string",
  "low_threshold_value": "string",
  "info_sql": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Alert Template ID
X-Auth-Token	header	string	true	Token of authorization
body	body	AlertTemplate	true	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Status 200	None

Response Schema

Info

This operation does not require authentication

`delete__alert_template_{id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X DELETE https://PEM-SERVER-IP/api/v2/alert/template/{id} \
  -H 'X-Auth-Token: string'

import requests
headers = {
  'X-Auth-Token': 'string'
}

r = requests.delete('https://PEM-SERVER-IP/api/v2/alert/template/{id}', headers = headers)

print(r.json())

const headers = {
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v2/alert/template/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /alert/template/{id}

Delete the Alert trmplate.

Parameters

Name	In	Type	Required	Description
id	path	integer	true	Alert Template ID
X-Auth-Token	header	string	true	Token of authorization

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Successful deletion	None

Response Schema

Info

This operation does not require authentication

← Prev

EDB Postgres Enterprise Manager REST APIs v2.0: Copy Alert

↑ Up

EDB Postgres Enterprise Manager REST APIs v2.0

EDB Postgres Enterprise Manager REST APIs v2.0: Custom Probe

EDB Postgres Enterprise Manager REST APIs v2.0: Alert template v10.2

get__alert_template_

Parameters

Responses

Response Schema

Enumerated Values

Info

post__alert_template_

Parameters

Responses

Response Schema

Info

get__alert_template_{id}

Parameters

Responses

Info

put__alert_template_{id}

Parameters

Responses

Response Schema

Info

delete__alert_template_{id}

Parameters

Responses

Response Schema

Info

← Prev

↑ Up

Next →

`get__alert_template_`

`post__alert_template_`

`get__alert_template_{id}`

`put__alert_template_{id}`

`delete__alert_template_{id}`