Products: Managed Backup (Agent)
Article ID: m0628Last Modified: 29-Sep-2024

GET API/Monitoring

Returns status data for latest runs for endpoints (all users).

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name Description Type Additional Information
PlanName - string None
CompanyName - string None
UserName User email string None
UserID UUID string None
ComputerName - string None
BuildVersion - string None
StorageType - string None
LastStart - date None
NextStart Next run date None
Status Plan status MonitoringPlanStatus None
ErrorMessage - string None
FilesCopied - integer None
FilesFailed - integer None
DataCopied Size of Data Copied integer None
Duration Operation Duration string None
DataToBackup Size of Data to Be Backed Up integer None
TotalData Size Total Data integer None
FilesScanned - integer None
FilesToBackup Files To Backup integer None
PlanId Plan Unique Identifier string None
PlanType Plan Type MonitoringPlanType None
DetailedReportLink Detailed Report Link 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-27T13:28:54.5374579+00:00",
    "NextStart": "2019-08-27T13:28:54.5374579+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-27T13:28:54.5374579+00:00",
    "NextStart": "2019-08-27T13:28:54.5374579+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-27T13:28:54.5374579+00:00</LastStart>
    <NextStart>2019-08-27T13:28:54.5374579+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-27T13:28:54.5374579+00:00</LastStart>
    <NextStart>2019-08-27T13:28:54.5374579+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