(GET) /backupTaskSessions/{ID}

In this article

    Returns a resource representation of a task having the specified ID. The parent backup job for the task is created and run on the backup server connected to Veeam Backup Enterprise Manager.

    Request

    To get a task having the specified ID, you need to send the GET HTTP request to the URL of the /backupTaskSessions/{ID} resource.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/backupTaskSessions/{ID}

    Request Headers

    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. For details, see Authentication and Security.

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    None.

    Query Parameters

    The following parameters can be used in queries:

    Parameter

    Type

    Description

    Can Be Used for Filtering

    Can Be Used for Sorting

    UID

    URN

    ID of the backup task session.

    True

    True

    Name

    String

    Name of the backup task session, for example: dc-hv@2013-08-25 05:01:09.

    True

    True

    CreationTime

    DateTime

    Date and time when the backup task session was launched. The parameter accepts only UTC-formatted DateTime values.

    True

    True

    EndTime

    DateTime

    Date and time when the backup task session was completed. The parameter accepts only UTC-formatted DateTime values.

    True

    True

    State

    String

    State of the backup task session. Possible values:

    • InProgress
    • Pending
    • Completed

    True

    True

    Result

    String

    Result of the backup task session. Possible values:

    • Success
    • Warning
    • Failed

    True

    True

    Reason

    String

    Reason for which the backup task session has been completed with the Warning or Failed result.

    True

    True

    TotalSize

    Long

    Size of all restore points produced by the backup job.

    True

    True

    JobSessionUid

    URN

    ID of the backup job session parent to the backup task session resource.

    True

    True

    JobUid

    URN

    ID of the backup job parent to the backup task session resource.

    True

    True

    JobName

    String

    Name of the backup job parent to the backup task session resource.

    True

    True

    BackupServerUid

    URN

    ID of the backup server on which the backup job is created.

    True

    True

    BackupServerName  

    String

    Name of the backup server on which the backup job is created.

    True

    True

    VmDisplayName  

    String

    Name of the VM that is processed in the backup task session.

    True

    True

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    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. Possible values:

    • application/xml
    • application/json

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupTaskSessions/{ID} resource.

    Example

    The example request below returns a resource representation of a task having ID 88767486-89d6-4340-92f0-2ad615a8f21b.

    Request:

    GET https://localhost:9398/api/backupTaskSessions/88767486-89d6-4340-92f0-2ad615a8f21b

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="BackupTaskSessionReference" Href="https://localhost:9398/api/backupTaskSessions/88767486-89d6-4340-92f0-2ad615a8f21b" Name="srv04@2014-10-19 05:23:44" UID="urn:veeam:BackupTaskSession:88767486-89d6-4340-92f0-2ad615a8f21b">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.tech.local" />
       <Link Rel="Up" Type="BackupJobSessionReference" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae" Name="Fileserver Backup@2014-10-19 05:22:52" />
       <Link Rel="Alternate" Type="BackupTaskSession" Href="https://localhost:9398/api/backupTaskSessions/88767486-89d6-4340-92f0-2ad615a8f21b?format=Entity" Name="srv04@2014-10-19 05:23:44" />
     </Links>
    </EntityRef>

     

    I want to report a typo

    There is a misspelling right here:

     

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