EDB Postgres Enterprise Manager REST APIs v5.0: Probe Configuration v10.2

`get__probe_config_server_{server_id}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/{probe_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/v5/probe/config/server/{server_id}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/{probe_id}

Get server level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`put__probe_config_server_{server_id}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/{probe_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/v5/probe/config/server/{server_id}/{probe_id}', headers = headers)

print(r.json())

const inputBody = '{
  "interval_min": 0,
  "interval_sec": 0,
  "lifetime": 0,
  "enabled": true
}';
const headers = {
  'Content-Type':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/{probe_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /probe/config/server/{server_id}/{probe_id}

Update server level probe configuration for specified probe id.

Body parameter

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

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization
body	body	ProbeConfigData	true	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Status 200	None

Response Schema

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}

Get all the schema level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}

Get schema level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`put__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}', headers = headers)

print(r.json())

const inputBody = '[
  {
    "interval_min": 0,
    "interval_sec": 0,
    "lifetime": 0,
    "enabled": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/{probe_id}

Update schema level probe configuration for specified probe id.

Body parameter

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

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization
body	body	ProbeConfigData	true	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Status 200	None

Response Schema

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_table_{table_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}

Get all the table level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
table_name	path	string	true	Table Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_table_{table_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/table/{table_name}/{probe_id}

Get table level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
table_name	path	string	true	Table Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_index_{index_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}

Get all the index level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
index_name	path	string	true	Index Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_index_{index_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/index/{index_name}/{probe_id}

Get index level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
index_name	path	string	true	Index Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_sequence_{sequence_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}

Get all the sequence level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
sequence_name	path	string	true	Sequence Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_sequence_{sequence_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/sequence/{sequence_name}/{probe_id}

Get sequence level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
sequence_name	path	string	true	Sequence Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_function_{function_name}_args_{function_arguments}_`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/ \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/

Get all the function level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
function_name	path	string	true	Function Name
function_arguments	path	string	false	Comma-separated list of function arguments.
X-Auth-Token	header	string	true	Token of authorization

Detailed descriptions

function_arguments: Comma-separated list of function arguments.

Eg: ag_id integer,srv_id integer

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_function_{function_name}_args_{function_arguments}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/args/{function_arguments}/{probe_id}

Get function level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
function_name	path	string	true	Function Name
function_arguments	path	string	false	Comma-separated list of function arguments.
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Detailed descriptions

function_arguments: Comma-separated list of function arguments.

Eg: ag_id integer,srv_id integer

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_view_{view_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}

Get all the view level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
view_name	path	string	true	View Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_schema_{schema_name}_view_{view_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/view/{view_name}/{probe_id}

Get view level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
schema_name	path	string	true	Schema Name
view_name	path	string	true	View Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`get__probe_config_agent_{agent_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/agent/{agent_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/v5/probe/config/agent/{agent_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/agent/{agent_id}',
{
  method: 'GET',

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

GET /probe/config/agent/{agent_id}

Get all the agent level probes.

Parameters

Name	In	Type	Required	Description
agent_id	path	integer	true	Agent ID
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_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/v5/probe/config/server/{server_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}

Get all the server level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name} \
  -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/v5/probe/config/server/{server_id}/database/{database_name}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}

Get all the database level probes.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Probes]	false	none	none
» probe_id	integer	false	none	Unique id of the probe.
» probe_name	string	false	none	Name of the probe.
» default_interval_min	integer	false	none	Defines default interval for the probe to collect the statistics (in minutes). Possible values are from 0 to 2880.
» interval_min	integer	false	none	Defines how frequently the probe will collect the statistics (in minutes). Possible values are from 0 to 2880.
» default_interval_sec	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds). Possible values are from 0 to 59.
» interval_sec	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds). Possible values are from 0 to 59.
» default_interval	integer	false	none	Defines default interval for the probe to collect the statistics (in seconds).
» interval	integer	false	none	Defines how frequently the probe will collect the statistics (in seconds).
» default_lifetime	integer	false	none	Defines the default history data retention time (in days).
» lifetime	integer	false	none	Defines the history data retention time (in days). It does not have any effect, if 'discard_history' is set to true.
» default_enabled	boolean	false	none	Defines the default probe enabled/disabled value.
» enabled	boolean	false	none	Defines whether the probe is enabled/disabled by default.
» target_type_id_returned	integer	false	none	Defines 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.

Info

This operation does not require authentication

`get__probe_config_server_{server_id}_database_{database_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/{probe_id}', headers = headers)

print(r.json())

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

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/{probe_id}',
{
  method: 'GET',

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

GET /probe/config/server/{server_id}/database/{database_name}/{probe_id}

Get database level probe for specified probe id.

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization

Example responses

200 Response

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

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Probes

Info

This operation does not require authentication

`put__probe_config_server_{server_id}_database_{database_name}_{probe_id}`

Code samples

cURL
Python
JavaScript

# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/{probe_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/v5/probe/config/server/{server_id}/database/{database_name}/{probe_id}', headers = headers)

print(r.json())

const inputBody = '[
  {
    "interval_min": 0,
    "interval_sec": 0,
    "lifetime": 0,
    "enabled": true
  }
]';
const headers = {
  'Content-Type':'application/json',
  'X-Auth-Token':'string'
};

fetch('https://PEM-SERVER-IP/api/v5/probe/config/server/{server_id}/database/{database_name}/{probe_id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /probe/config/server/{server_id}/database/{database_name}/{probe_id}

Update database level probe configuration for specified probe id.

Body parameter

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

Parameters

Name	In	Type	Required	Description
server_id	path	integer	true	Server ID
database_name	path	string	true	Database Name
probe_id	path	integer	true	Probe ID for which probe configuration will be returned.
X-Auth-Token	header	string	true	Token of authorization
body	body	ProbeConfigData	true	none

Example responses

Responses

Status	Meaning	Description	Schema
200	OK	Status 200	None

Response Schema

Info

This operation does not require authentication

← Prev

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

↑ Up

EDB Postgres Enterprise Manager REST APIs v5.0

EDB Postgres Enterprise Manager REST APIs v5.0: Copy Probe