Creating Retrieval Jobs

In this article

    You can create a retrieval job.

    Creating Retrieval Jobs Note

    You must create individual retrieval jobs for different types of objects whose backed-up data you want to retrieve.

    Request

    POST https://<hostname>:4443/v6/DataRetrievals

    Request Headers

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

    Request Parameters

    None.

    Request Body

    The request body must contain the following properties:

    Property

    Type

    Description

    name

    string

    Specifies a name of the retrieval job.

    description

    string

    Specifies a description of the retrieval job.

    organizationId

    string

    Specifies the backed-up organization unique ID.

    repositoryId

    string

    Specifies the backup repository extended with an archive object storage ID.

    amazonS3GlacierRetrievalPolicy

    string

    Specifies the retrieval policy for Amazon S3 Glacier and Amazon S3 Glacier Deep Archive object storage. The following values are available:

    • Expedited
    • Standard
    • Bulk

    azureArchiveRetrievalPolicy

    string

    Specifies the retrieval policy for Azure Archive Storage. The following values are available:

    • StandardPriority
    • HighPriority

    pointInTime

    UTC

    Specifies point in time that you want to retrieve from a backup repository extended with an archive object storage.

    availabilityPeriodDays

    integer

    Specifies how many days you will be able to explore and restore the retrieved data using Veeam Explorers.

    enableExpirationNotification

    boolean

    If set to true, indicates that Veeam Backup for Microsoft 365 sends a notification by email before the retrieved data expires.

    expirationHoursThreshold

    integer

    Specifies how many hours should remain before the retrieved data expires to send a notification by email.  Use this property only with the enableExpirationNotification property.

    showDeleted

    boolean

    Defines whether the data retrieval session will show items that have been removed by the user before the specified point in time.

    showAllVersions

    boolean

    Defines whether the data retrieval session will show all versions of items that have been modified by the user before the specified point in time.

    mailboxes

    mailbox[]

    Specifies the IDs of mailboxes whose backed-up data you want to retrieve from an archive. For more information on how to get such IDs, see Getting Mailbox Data by Repository ID.

    oneDrives

    oneDrive[]

    Specifies the IDs of OneDrives whose backed-up data you want to retrieve from an archive. For more information on how to get such IDs, see Getting OneDrive Data by Repository ID.

    sites

    site[]

    Specifies the IDs of SharePoint sites whose backed-up data you want to retrieve from an archive. For more information on how to get such IDs, see Getting SharePoint Data by Repository ID.

    teams

    team[]

    Specifies the IDs of teams whose backed-up data you want to retrieve from an archive. For more information on how to get such IDs, see Getting Teams Data by Repository ID.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 201 Created.

    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

    In the response body, the server returns a resource representation of the /DataRetrievals/{dataRetrievalId} resource. For more information, see Getting Retrieval Jobs.

    Example

    Request:

    POST https://abc.tech.local:4443/v6/DataRetrievals

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "name": "OneDrive Data Retrieval",

     "description": "for OneDrives",

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

     "pointInTime": "2022-01-28T18:07:10.594Z",

     "showDeleted": true,

     "showAllVersions": true,

     "availabilityPeriodDays": 10,

     "enableExpirationNotification": true,

     "expirationHoursThreshold": 5,

     "oneDrives": [

       {

         "id": "18113f79-5344-43bf-962c-44dfdd4160db70e7bee3-08ea-48ac-ba1a-16863f06e1e2",

        },

       {

         "id": "2bba7ec6-4711-4ad8-8c43-335abee74d313a8f02b1-4f00-4123-9067-3fb7e71177b4",

        }

     ],

    "amazonS3GlacierRetrievalPolicy": "Expedited"

     }

     

    Response:

    201 Created

     

    Response Body:

    {

     "name": "OneDrive Data Retrieval",

     "description": "for OneDrives",

     "storageType": "AmazonS3Glacier",

     "amazonS3GlacierRetrievalPolicy": "Expedited",

     "id": "3136489d-4290-4e88-a013-d0f36f4ffe72",

     "pointInTime": "2022-01-28T18:07:10.594Z",

     "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b",

     "organizationUniqueId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6",

     "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265",

     "dataState": "Retrieving",

     "lastStatus": "Running",

     "startTime": "2022-01-28T19:28:52.2270824Z",

     "enableExpirationNotification": true,

     "expirationHoursThreshold": 5,

     "type": "OneDrive",

     "showDeleted": true,

     "showAllVersions": true,

     "_links": {

       "self": {

         "href": "/v6/dataRetrievals/3136489d-4290-4e88-a013-d0f36f4ffe72"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       },

       "proxy": {

         "href": "/v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6"

       },

       "backupRepository": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       },

       "onedrives": {

         "href": "/v6/dataRetrievals/3136489d-4290-4e88-a013-d0f36f4ffe72/onedrives"

       }

     },

     "_actions": {

       "update": {

         "uri": "v6/dataRetrievals/3136489d-4290-4e88-a013-d0f36f4ffe72",

         "method": "PUT"

       }

     }

    }