GET /backupSessions/{ID}

In this article

    Returns a resource representation of a backup job session having the specified ID.

    Request

    To get a job session, send the GET HTTP request to the URL of the /backupSessions/{ID} resource.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/backupSessions/{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.

    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 an entity or an entity reference of the /backupSessions/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    Type

    Description

    UID

    UidType

    UID of the backup job session resource, for example: urn:veeam:BackupJobSession:88b395e2-81ff-439c-558c-188d97274c15.

    Name

    String

    Name of the backup job session resource, for example: exch@2013-08-26 22:28:51.

    JobUid

    UidType

    UID of the backup job parent to the backup job session resource, for example: urn:veeam:Job:dce85686-59c8-42c4-8766-f1c00a5b8067.

    JobName

    String

    Name of the backup job parent to the backup job session resource, for example: SQL Backup.

    JobType

    String

    Type of the backup job session. Possible values:

    • Backup — for VM backup job session resources.
    • AgentBackup — for Veeam Agent backup job session resources. Represents a Veeam Agent job session container state and progress, contains links for child Veeam Agent job sessions.
    • AgentManagement — for Veeam Agent child job session resources. Represents a Veeam Agent protected machine backup state and backup progress, contains links for restore points and the parent backup job session.
    • NasBackup — for file share backup job session resources.

    CreationTime

    DateTime

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

    EndTime

    DateTime

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

    State

    String

    State of the backup job session. Possible values:

    • Starting
    • Stopping
    • Working
    • Pausing
    • Resuming
    • Stopped  

    Result

    String

    Result of the backup job session. Possible values:

    • Success
    • Warning
    • Failed

    Progress

    Int

    Progress of the backup job session.

    IsRetry

    Boolean

    Defines whether the backup job session has been retried or not. Possible values:

    • True
    • False

    To view query parameters that you can use for filtering or sorting, see GET /query?type=BackupJobSession.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Up

    URL of the /backupServers/{ID} resource — a backup server where the related backup job was created.

    /jobs/{ID}

    Up

    URL of the /jobs/{ID} resource parent to the backup session.

    /backupSessions/{ID}

    Alternate

    Alternate URL of the /backupSessions/{ID} resource.

    /backupSessions/{ID}/taskSessions

    Down

    URL of the /backupSessions/{ID}/taskSessions resource — a collection of backup task sessions created within the backup session.

    /backupSessions/{ID}?action=stop

    Stop

    URL for the POST /backupSessions/{ID}?action=stop request.

    /restorePoints/{ID}

    Down

    URL of the /restorePoints/{ID} resource — a restore point created during the backup session.

    Example

    A sample request below returns an entity representation of the backup job session resource having ID a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6.

    Request:

    GET https://localhost:9398/api/backupSessions/a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <?xml version="1.0" encoding="utf-8"?>
    <BackupJobSession xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://enterprise04.tech.local:9398/api/backupSessions/a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6?format=Entity" Type="BackupJobSession" Name="Backup Job 3@2021-09-24 20:00:09" UID="urn:veeam:BackupJobSession:a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6" xmlns="http://www.veeam.com/ent/v1.0">
       <Links>
           <Link Href="https://localhost:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f" Name="enterprise01.tech.local" Type="BackupServerReference" Rel="Up" />
           <Link Href="https://localhost:9398/api/jobs/2b078668-e45d-4eb3-abb0-275b0d130e7e" Name="Backup Job 3" Type="JobReference" Rel="Up" />
           <Link Href="https://localhost:9398/api/backupSessions/a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6" Name="Backup Job 3@2021-09-24 20:00:09" Type="BackupJobSessionReference" Rel="Alternate" />
           <Link Href="https://localhost:9398/api/backupSessions/a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6/taskSessions" Type="BackupTaskSessionReferenceList" Rel="Down" />
           <Link Href="https://localhost:9398/api/backupSessions/a057c2c3-f3bd-4ab4-9fb7-24058cccb4f6?action=stop" Rel="Stop" />
           <Link Href="https://localhost:9398/api/restorePoints/a5eed1d4-cf03-4ab5-bc63-deffcfeb728c" Name="" Type="RestorePointReference" Rel="Related" />
       </Links>
       <JobUid>urn:veeam:Job:2b078668-e45d-4eb3-abb0-275b0d130e7e</JobUid>
       <JobName>Backup Job 3</JobName>
       <JobType>Backup</JobType>
       <CreationTimeUTC>2021-09-24T20:00:09.607Z</CreationTimeUTC>
       <EndTimeUTC>2021-09-24T20:02:54.717Z</EndTimeUTC>
       <State>Stopped</State>
       <Result>Success</Result>
       <Progress>100</Progress>
       <IsRetry>false</IsRetry>
    </BackupJobSession>