This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /reports/summary/overview

In this article

    Returns a resource representation of an overview report about backup infrastructure components and performed backup and replication jobs.

    Request

    To get an overview report, you need to send the GET HTTP request to the URL of the /reports/summary/overview resource.

    HTTP Request

    GET http://<Enterprise-Manager>:9399/api/reports/summary/overview

    Request Header

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

    Request Body

    None.

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 Success.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message: application/xml.

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /reports/summary/overview resource.

    Example

    The example below returns an overview report informing about backup infrastructure components and performed jobs.

    Request:

    GET http://localhost:9399/api/reports/summary/overview

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 Success

     

    Response Body:

    <OverviewReportFrame xmlns="http://www.veeam.com/ent/v1.0">
     <BackupServers>2</BackupServers>
     <ProxyServers>4</ProxyServers>
     <RepositoryServers>6</RepositoryServers>
     <RunningJobs>0</RunningJobs>
     <ScheduledJobs>2</ScheduledJobs>
     <SuccessfulVmLastestStates>18</SuccessfulVmLastestStates>
     <WarningVmLastestStates>0</WarningVmLastestStates>
     <FailedVmLastestStates>0</FailedVmLastestStates>
    </OverviewReportFrame>