Status Reporting Controller Resource

The API allows you to view and send status report.

POST /status-reporting/report

Send status report.

Example

Request
POST /status-reporting/report
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 201 Created

              

GET /status-reporting/report-preview

Get status report preview.

Response Body
media type data type description
application/json VProtectReportRequestV2 (JSON) details of status report

Example

Request
GET /status-reporting/report-preview
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "instanceId" : "...",
  "serverVersion" : "...",
  "nodes" : [ {
    "guid" : "...",
    "name" : "...",
    "version" : "...",
    "lastSeen" : 12345,
    "state" : "QUEUED_STOP",
    "totalSpace" : 12345,
    "usedSpace" : 12345,
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345
  }, {
    "guid" : "...",
    "name" : "...",
    "version" : "...",
    "lastSeen" : 12345,
    "state" : "STOPPING",
    "totalSpace" : 12345,
    "usedSpace" : 12345,
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345
  } ],
  "generalInfo" : {
    "property1" : "...",
    "property2" : "..."
  },
  "protectionStats" : {
    "vm" : {
      "protectedEntityType" : "CLOUD_SITE",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "app" : {
      "protectedEntityType" : "OS",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "storage" : {
      "protectedEntityType" : "CLOUD_USER",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "cloudGroup" : {
      "protectedEntityType" : "CLOUD_SITE",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "cloudTeam" : {
      "protectedEntityType" : "OS_AGENT",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "cloudSite" : {
      "protectedEntityType" : "STORAGE",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    },
    "cloudUser" : {
      "protectedEntityType" : "CLOUD_SITE",
      "noSchedule" : 12345,
      "notProtected" : 12345,
      "protectedNo" : 12345
    }
  },
  "backupsInLast24h" : [ {
    "protectedEntityType" : "CLOUD_TEAMS",
    "failed" : 12345,
    "inProgress" : 12345,
    "successful" : 12345,
    "queued" : 12345,
    "totalData" : 12345,
    "effectiveBackupObjectCount" : 12345
  }, {
    "protectedEntityType" : "STORAGE",
    "failed" : 12345,
    "inProgress" : 12345,
    "successful" : 12345,
    "queued" : 12345,
    "totalData" : 12345,
    "effectiveBackupObjectCount" : 12345
  } ],
  "backupInfo" : [ {
    "backupGuid" : "...",
    "protectedEntity" : "...",
    "protectedEntityGuid" : "...",
    "protectedEntityType" : "...",
    "originEntity" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "originEntityString" : "...",
    "status" : "INPROGRESS",
    "size" : 12345,
    "type" : "...",
    "snapshotTime" : 12345,
    "statusInfo" : "...",
    "hypervisor" : "...",
    "hypervisorGuid" : "...",
    "hvManager" : "...",
    "hvManagerGuid" : "...",
    "dataCenter" : "...",
    "cluster" : "...",
    "storageProvider" : "...",
    "storageProviderGuid" : "...",
    "storagePool" : "...",
    "policy" : "...",
    "policyGuid" : "...",
    "sourceProject" : "...",
    "taskDurationTime" : 12345
  }, {
    "backupGuid" : "...",
    "protectedEntity" : "...",
    "protectedEntityGuid" : "...",
    "protectedEntityType" : "...",
    "originEntity" : {
      "type" : { },
      "guid" : "...",
      "name" : "..."
    },
    "originEntityString" : "...",
    "status" : "SUCCESS_REMOVED",
    "size" : 12345,
    "type" : "...",
    "snapshotTime" : 12345,
    "statusInfo" : "...",
    "hypervisor" : "...",
    "hypervisorGuid" : "...",
    "hvManager" : "...",
    "hvManagerGuid" : "...",
    "dataCenter" : "...",
    "cluster" : "...",
    "storageProvider" : "...",
    "storageProviderGuid" : "...",
    "storagePool" : "...",
    "policy" : "...",
    "policyGuid" : "...",
    "sourceProject" : "...",
    "taskDurationTime" : 12345
  } ],
  "hypervisorManagersInfo" : [ {
    "type" : "...",
    "subtype" : "...",
    "version" : "...",
    "value" : 12345
  }, {
    "type" : "...",
    "subtype" : "...",
    "version" : "...",
    "value" : 12345
  } ],
  "hypervisorsInfo" : [ {
    "type" : "...",
    "subtype" : "...",
    "version" : "...",
    "value" : 12345
  }, {
    "type" : "...",
    "subtype" : "...",
    "version" : "...",
    "value" : 12345
  } ],
  "storageProvidersInfo" : [ {
    "type" : "...",
    "version" : "...",
    "value" : 12345
  }, {
    "type" : "...",
    "version" : "...",
    "value" : 12345
  } ],
  "license" : {
    "hash" : "...",
    "valid" : true,
    "validUntil" : 12345,
    "email" : "...",
    "props" : {
      "property1" : "...",
      "property2" : "..."
    },
    "propsWithUsage" : {
      "property1" : {
        "maxValue" : "...",
        "availableValue" : "..."
      },
      "property2" : {
        "maxValue" : "...",
        "availableValue" : "..."
      }
    }
  },
  "cloudInfo" : {
    "cloudServiceProviders" : 12345,
    "cloudSites" : 12345,
    "cloudGroups" : 12345,
    "cloudTeams" : 12345,
    "cloudUsers" : 12345
  },
  "osAgents" : [ {
    "guid" : "...",
    "lastLoginDate" : 12345,
    "lastSeen" : 12345,
    "status" : "CONNECTED",
    "osType" : "MAC"
  }, {
    "guid" : "...",
    "lastLoginDate" : 12345,
    "lastSeen" : 12345,
    "status" : "DECOMMISSIONED",
    "osType" : "MAC"
  } ],
  "protectedEntitiesWithBackup" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  }
}
                
              

POST /status-reporting/report-with-logs

Send status report with logs.

Example

Request
POST /status-reporting/report-with-logs
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 201 Created