GET API/Monitoring/{UserID}

Returns status data for latest runs for endpoints which are currently online filtered by specified user ID.

Request Information

URI Parameters

Name Description Type Additional Information
userId Existing user ID string Required

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional Information
PlanName - string None
CompanyName Company name (in case a user is assigned to a company) string None
UserName User email or domain name string None
UserID User GUID string None
ComputerName - string None
BuildVersion Agent version string None
StorageType - string None
LastStart The last run starting time date None
NextStart Next run starting time (if scheduled) date None
Status The last run status MonitoringPlanStatus None
ErrorMessage - string None
FilesCopied Number of files copied integer None
FilesFailed Number of files failed to copy integer None
DataCopied Total size of data copied integer None
Duration Duration of the last plan run string None
DataToBackup A size of data to back up integer None
TotalData Total backup size integer None
FilesScanned Number of files scanned before a backup plan run integer None
FilesToBackup The number of files to back up integer None
PlanId Plan GUID string None
PlanType Plan type code MonitoringPlanType None
DetailedReportLink A link to download a detailed report string None

Response Formats

application/json, text/json

[
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "BuildVersion": "sample string 6",
    "StorageType": "sample string 7",
    "LastStart": "2019-08-27T14:44:58.26092+00:00",
    "NextStart": "2019-08-27T14:44:58.26092+00:00",
    "Status": 0,
    "ErrorMessage": "sample string 8",
    "FilesCopied": 9,
    "FilesFailed": 10,
    "DataCopied": 11,
    "Duration": "sample string 12",
    "DataToBackup": 13,
    "TotalData": 14,
    "FilesScanned": 15,
    "FilesToBackup": 16,
    "PlanId": "sample string 17",
    "PlanType": 0,
    "DetailedReportLink": "sample string 18"
  },
  {
    "PlanName": "sample string 1",
    "CompanyName": "sample string 2",
    "UserName": "sample string 3",
    "UserID": "sample string 4",
    "ComputerName": "sample string 5",
    "BuildVersion": "sample string 6",
    "StorageType": "sample string 7",
    "LastStart": "2019-08-27T14:44:58.26092+00:00",
    "NextStart": "2019-08-27T14:44:58.26092+00:00",
    "Status": 0,
    "ErrorMessage": "sample string 8",
    "FilesCopied": 9,
    "FilesFailed": 10,
    "DataCopied": 11,
    "Duration": "sample string 12",
    "DataToBackup": 13,
    "TotalData": 14,
    "FilesScanned": 15,
    "FilesToBackup": 16,
    "PlanId": "sample string 17",
    "PlanType": 0,
    "DetailedReportLink": "sample string 18"
  }
]

application/xml, text/xml

<ArrayOfMonitoringModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <MonitoringModels>
    <BuildVersion>sample string 6</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>11</DataCopied>
    <DataToBackup>13</DataToBackup>
    <DetailedReportLink>sample string 18</DetailedReportLink>
    <Duration>sample string 12</Duration>
    <ErrorMessage>sample string 8</ErrorMessage>
    <FilesCopied>9</FilesCopied>
    <FilesFailed>10</FilesFailed>
    <FilesScanned>15</FilesScanned>
    <FilesToBackup>16</FilesToBackup>
    <LastStart>2019-08-27T14:44:58.26092+00:00</LastStart>
    <NextStart>2019-08-27T14:44:58.26092+00:00</NextStart>
    <PlanId>sample string 17</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 7</StorageType>
    <TotalData>14</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
  <MonitoringModels>
    <BuildVersion>sample string 6</BuildVersion>
    <CompanyName>sample string 2</CompanyName>
    <ComputerName>sample string 5</ComputerName>
    <DataCopied>11</DataCopied>
    <DataToBackup>13</DataToBackup>
    <DetailedReportLink>sample string 18</DetailedReportLink>
    <Duration>sample string 12</Duration>
    <ErrorMessage>sample string 8</ErrorMessage>
    <FilesCopied>9</FilesCopied>
    <FilesFailed>10</FilesFailed>
    <FilesScanned>15</FilesScanned>
    <FilesToBackup>16</FilesToBackup>
    <LastStart>2019-08-27T14:44:58.26092+00:00</LastStart>
    <NextStart>2019-08-27T14:44:58.26092+00:00</NextStart>
    <PlanId>sample string 17</PlanId>
    <PlanName>sample string 1</PlanName>
    <PlanType>NA</PlanType>
    <Status>Success</Status>
    <StorageType>sample string 7</StorageType>
    <TotalData>14</TotalData>
    <UserID>sample string 4</UserID>
    <UserName>sample string 3</UserName>
  </MonitoringModels>
</ArrayOfMonitoringModels>
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git