Probe Configuration#
get_probe_config_agent{agent_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
This operation does not require authentication
get_probe_config_server{server_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
This operation does not require authentication
get_probe_config_server{server_id}_{probe_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
put_probe_config_server{server_id}_{probe_id}#
Code samples
# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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 |
true |
none |
Example responses
Responses#
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Status 200 |
None |
Response Schema#
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}_{probe_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
put_probe_config_server{server_id}database{database_name}_{probe_id}#
Code samples
# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Updates 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 |
true |
none |
Example responses
Responses#
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Status 200 |
None |
Response Schema#
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}_{probe_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
put_probe_config_server{server_id}database{database_name}schema{schema_name}_{probe_id}#
Code samples
# You can also use wget
curl -X PUT https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Updates 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 |
true |
none |
Example responses
Responses#
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
Status 200 |
None |
Response Schema#
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}table{table_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
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
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}index{index_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
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
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}sequence{sequence_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
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
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}function{function_name}_#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_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/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/, headers = headers)
print(r.json())
const headers = {
Accept:application/json,
X-Auth-Token:string
};
fetch(https://PEM-SERVER-IP/api/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_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}/function/{function_name}/
Gets 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 |
X-Auth-Token |
header |
string |
true |
Token of authorization |
Example responses
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}function{function_name}_{probe_id}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_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/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_name}/{probe_id}, headers = headers)
print(r.json())
const headers = {
Accept:application/json,
X-Auth-Token:string
};
fetch(https://PEM-SERVER-IP/api/v14/probe/config/server/{server_id}/database/{database_name}/schema/{schema_name}/function/{function_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}/function/{function_name}/{probe_id}
Gets 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 |
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
{
"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 |
Successful response |
Note
This operation does not require authentication
get_probe_config_server{server_id}database{database_name}schema{schema_name}view{view_name}#
Code samples
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
[
{
"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 |
Successful response |
Inline |
Response Schema#
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 the default interval for the probe to collect statistics (in minutes). Possible values are 0 to 2880. |
» interval_min |
integer |
false |
none |
Defines how frequently the probe collects statistics (in minutes). Possible values are 0 to 2880. |
» default_interval_sec |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). Possible values are 0 to 59. |
» interval_sec |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds). Possible values are 0 to 59. |
» default_interval |
integer |
false |
none |
Defines the default interval for the probe to collect statistics (in seconds). |
» interval |
integer |
false |
none |
Defines how frequently the probe collects statistics (in seconds).Must be greater than or equal to 10 |
» 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). Valid range is 1-365. This value 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 |
Specifies whether whether the probe is enabled/disabled by default. |
» target_type_id_returned |
integer |
false |
none |
Defines the return target type value. <ul><li>A probe with target_type <b>100</b> is responsible for collecting statistics for an agent.</li><li>A probe with target_type <b>200</b> is responsible for collecting statistics for a monitored server.</li><li>A probe with target_type <b>300</b> is responsible for collecting statistics for a database.</li><li>A probe with target_type <b>400</b> is responsible for collecting statistics for a schema.</li><li>A probe with target_type <b>500</b> is responsible for collecting statistics for a table.</li><li>A probe with target_type <b>600</b> is responsible for collecting statistics for a index.</li><li>A probe with target_type <b>700</b> is responsible for collecting statistics for a sequence.</li><li>A probe with target_type <b>800</b> is responsible for collecting statistics for a function.</li><li>A probe with target_type <b>900</b> is responsible for collecting statistics for a view.</li></ul> |
Note
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
# You can also use wget
curl -X GET https://PEM-SERVER-IP/api/v14/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/v14/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/v14/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}
Gets 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
{
"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 |
Successful response |
Note
This operation does not require authentication