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 a representation of the /backupSessions/{ID} resource.

    You can use the following parameters in the GET /query?type=BackupJobSession query:

    Parameter

    Type

    Description

    Can Be Used for Filtering

    Can Be Used for Sorting

    Uid

    URN

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

    True

    True

    Name

    String

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

    True

    True

    JobType

    String

    Type of the backup job session. Possible values:

    • Backup — for VM backup job session resources.
    • AgentBackup — for Agent Management backup job session resources. Represents an Agent Management job session container state and progress, contains links for child Agent Management job sessions.
    • AgentManagement — for Agent Management child job session resources. Represents an Agent Management 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.

    True

    True

    JobUid

    URN

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

    True

    True

    JobName

    String

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

    True

    True

    CreationTime

    DateTime

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

    True

    True

    EndTime

    DateTime

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

    True

    True

    State

    String

    State of the backup job session. Possible values:

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

    True

    True

    Result

    String

    Result of the backup job session. Possible values:

    • Success
    • Warning
    • Failed

    True

    True

    IsRetry

    Boolean

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

    • True
    • False

    True

    True

    BackupServerUid

    URN

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

    True

    True

    BackupServerName

    String

    Name of the backup server parent to the backup session resource.

    True

    True

    Example

    A sample request below returns an entity representation of the backup job session resource having ID d46e39e0-1131-4585-91a7-e828ce7eafae.

    Request:

    GET https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <BackupJobSession xmlns="http://www.veeam.com/ent/v1.0" Type="BackupJobSession" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae?format=Entity" Name="Fileserver Backup@2014-10-19 05:22:52" UID="urn:veeam:BackupJobSession:d46e39e0-1131-4585-91a7-e828ce7eafae">
     <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="JobReference" Href="https://localhost:9398/api/jobs/4856ab37-2235-45e8-affe-d515878b01a9" Name="Fileserver Backup" />
       <Link Rel="Alternate" Type="BackupJobSessionReference" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae" Name="Fileserver Backup@2014-10-19 05:22:52" />
       <Link Rel="Down" Type="BackupTaskSessionReferenceList" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae/taskSessions" />
       <Link Rel="Stop" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae?action=stop" />
       <Link Rel="Related" Type="RestorePointReference" Href="https://localhost:9398/api/restorePoints/a2d7d2a9-8407-4585-9649-515ecb04b35a" Name="Oct 19 2014  5:23AM" />
     </Links>
     <JobUid>urn:veeam:Job:4856ab37-2235-45e8-affe-d515878b01a9</JobUid>
     <JobName>Fileserver Backup</JobName>
     <JobType>Backup</JobType>
     <CreationTimeUTC>2014-10-19T05:22:52Z</CreationTimeUTC>
     <EndTimeUTC>2014-10-19T05:40:48Z</EndTimeUTC>
     <State>Stopped</State>
     <Result>Success</Result>
     <Progress>100</Progress>
     <IsRetry>false</IsRetry>
    </BackupJobSession>