Editing Retrieval Job Settings

You can edit a retrieval job with the specified ID.

Request

PUT https://<hostname>:4443/v6/DataRetrievals/{dataRetrievalId}

Request Headers

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

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

dataRetrievalId

string

Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Getting Retrieval Jobs.

Request Body

The request body must contain the following properties:

Property

Type

Description

name

string

Specifies the retrieval job name.

description

string

Specifies the retrieval job description.

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

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

None.

Example

The example shows how to edit settings of the retrieval job with the ID b75d54e8-4c0b-45ab-90ef-a64e2411e1ee.

Request:

PUT https://abc.tech.local:4443/v6/DataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "name": "Retrieval Job",

 "description": "SharePoint Data Retrieval",

 "availabilityPeriodDays": 10,

 "enableExpirationNotification": true,

 "expirationHoursThreshold": 5

}

 

Response:

200 OK