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

Getting Synchronization Session Statistics

In this article

    This section explains how to get synchronization session statistics.

    Request

    GET https://<hostname>:4443/v4/RepositorySynchronizeSessions/{sessionId}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be posted as URL.

    Parameter

    Type

    Description

    sessionId

    string

    An identification number of the synch session. Can be obtained as described in Getting Synchronization Sessions.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 (OK).

    Response Headers

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

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    Parameter

    Type

    Description

    repositoryId

    string

    Shows the identification number of the backup repository being synchronized.

    state

    string

    Shows the synchronization state.

    progressPercent

    string

    Shows the synchronization progress in percents.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    Request:

    GET https://abc.tech.local:4443/v4/RepositorySynchronizeSessions/c6d1fc1b-1aef-411f-9a7f-de35e546c615

     

    Response:

    200 OK

     

    Response Body:

    {

      "repositoryId": "c6d1fc1b-1aef-411f-9a7f-de35e546c615",

      "state": "Synchronizing",

      "progressPercent": 0,

      "_links":    {

         "self": {"href": "https://epsilon.tech.local:4443/v4/RepositorySynchronizeSessions/c6d1fc1b-1aef-411f-9a7f-de35e546c615"},

         "repository": {"href": "https://epsilon.tech.local:4443/v4/backuprepositories/c6d1fc1b-1aef-411f-9a7f-de35e546c615"}

      }

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.