GET /query?type=BackupJobSession

In this article

    Returns a resource representation of a collection of backup job sessions performed on backup servers connected to Veeam Backup Enterprise Manager. For details, see /backupSessions.

    Request

    To get a list of backup job sessions, send the GET HTTP request to the query with the type parameter set to BackupJobSession.

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/query?type=BackupJobSession

    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.

    Optional Parameters

    In the query, you can use the following parameters for filtering and sorting.

    Parameter

    Type

    Description

    Uid

    URN

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

    Name

    String

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

    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.

    JobUid

    URN

    ID 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.

    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

    IsRetry

    Boolean

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

    • True
    • False

    BackupServerUid

    URN

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

    BackupServerName

    String

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

    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 resource collection.

    Example

    The example below returns an entity resource representation of a collection of failed sessions for the Backup Job 2 job.

    Request:

    GET https://localhost:9398/web/#/api/query?type=BackupJobSession&format=Entities&filter=Result==Failed;JobName=="Backup Job 2"

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <QueryResult xmlns="http://www.veeam.com/ent/v1.0">
     <Entities>
       <BackupServers>
         <BackupServer Type="BackupServer" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?format=Entity" Name="enterprise06.tech.local" UID="urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563">
           <Links>
             <Link Rel="Alternate" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" />
             <Link Rel="Edit" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" />
             <Link Rel="Delete" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" />
             <Link Rel="Down" Type="JobReferenceList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/jobs" />
             <Link Rel="Down" Type="ManagedServerReferenceList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/managedServers" />
             <Link Rel="Down" Type="RepositoryReferenceList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/repositories" />
             <Link Rel="Down" Type="ExternalRepositoryReferenceList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/externalRepositories" />
             <Link Rel="Down" Type="CredentialsList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/credentials" />
             <Link Rel="Create" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/credentials?action=create" />
             <Link Rel="Down" Type="PasswordKeyList" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/passwords" />
             <Link Rel="Create" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563/passwords?action=create" />
             <Link Rel="VeeamZip" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?action=veeamzip" />
             <Link Rel="QuickBackup" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?action=quickbackup" />
             <Link Rel="Start" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?action=collect" />
           </Links>
           <Description />
           <Port>9392</Port>
           <Version>11.0.0.837</Version>
         </BackupServer>
       </BackupServers>
     </Entities>
     <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
       <Links>
         <Link Rel="First" Href="https://localhost:9398/api/query?type=BackupServer&format=Entities&filter=Version=="11.0.0.837"&pageSize=100&page=1" />
         <Link Rel="Last" Href="https://localhost:9398/api/query?type=BackupServer&format=Entities&filter=Version=="11.0.0.837"&pageSize=100&page=1" />
       </Links>
     </PagingInfo>
    </QueryResult>