List Exchange Storage History
Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.
|
Service name: list_exchange_storage_history |
|
|
URL |
https://SERVER/api/?apikey=yourAPIkey&service=list_exchange_storage_history &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
|
Description |
Returns the daily (interval=DAY), weekly (interval=WEEK) or monthly (interval=MONTH) Exchange Store Size information for a device. Only available for devices where the (Windows server only) Exchange Store Size Check is configured. |
|
Parameters |
|||||||||||||||||
|
Post Variable |
Description |
Type |
Required |
Options |
Default |
||||||||||||
|
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|||||||||||||
|
deviceid |
The deviceid must be a valid id. |
integer |
yes |
0 |
0 |
||||||||||||
|
interval |
Interval length: DAY WEEK MONTH |
string |
yes |
DAY WEEK MONTH |
0 |
||||||||||||
|
since |
Only obtain data since this date/time (inclusive); otherwise all available data is returned. All UTC, ISO-8601; format depends on interval:
|
string |
no |
0 |
0 |
||||||||||||
|
Example Service Call =list_exchange_storage_history |
|
https://SERVER/api/?apikey=yourAPIkey&service=list_exchange_storage_history&deviceid=DEVICEID&interval=INTERVAL&since=SINCE |
|
Example Response |
|
<?xml version="1.0" ?> <example> <result created="2013-09-26T11:49:41+01:00" host="SERVER" status="OK"> <store> <store_name>an_exchange_store_name</store_name> <edb_file>C:\a\path\to\edb\file</edb_file> <slv_file>C:\a\path\to\slv\file</slv_file> <check_id>17186</check_id> [Check responsible for populating this data] <history> <data> <day>2013-08-05</day>[only if interval=DAY. UTC ISO-8601 year month day] <week>2013W31</week>[only if interval=WEEK. UTC ISO-8601 year week] <month>2013-08</month>[only if interval=MONTH. UTC ISO-8601 year month] <store_size>52672</store_size>[megabytes] </data> <data> <day>2013-08-06</day> <store_size>52978</store_size> </data> <data> <day>2013-08-07</day> <store_size>54241</store_size> </data> [...more data elements...] </history> </store> [...more store elements (if applicable)...] </result> </example> |
|
Fields Description |
|||||||||||||
|
An exchange_storage element containing store elements (or none if no data available) for each drive which has a corresponding check on the device; each drive element contains: |
|||||||||||||
|
key |
description |
||||||||||||
|
store_name |
name of monitored Exchange store |
||||||||||||
|
edb_file |
name of monitored/measured EDB file |
||||||||||||
|
slv_file |
name of monitored/measured SLV file |
||||||||||||
|
check_id |
the check which populated this data |
||||||||||||
|
history |
a list (in XML output these will be data elements), each entry containing:
|
||||||||||||
|
Notes |
|
Data is available for a maximum of 61 intervals (for each possible interval), if you need data for longer you must store a copy yourself then - for efficiency - provide the since parameter to only request new data |
| Example Associated Service Calls | ||
| Parameter | Call | URL Format |
| DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
| list_servers |
https://SERVER/api/?apikey=yourAPIkey&service=list_servers&siteid=SITEID |
|
| list_workstations |
https://SERVER/api/?apikey=yourAPIkey&service=list_workstations&siteid=SITEID |
|
| SiteID | list_sites | https://SERVER/api/?apikey=yourAPIkey&service=list_sites&clientid=CLIENTID |
| ClientID | list_clients | https://SERVER/api/?apikey=yourAPIkey&service=list_clients |