Veeam Backup for Microsoft Office 365 RESTful API: General settings

Veeam Backup for Microsoft Office 365 RESTful API: General settings

In the final part of the RESTful API series for Veeam Backup for Microsoft Office 365, we’ll go over some general settings which can be modified as well. These are fairly self-explaining.

Exclusion settings

The following request allows you to modify the backup exclusion settings. As this is a global setting, backup jobs will not process specified data.
We will perform a PUT request against “/v4/ExclusionSettings“.

{
  "deletedItems": "true",
  "drafts": "false",
  "junkEmail": "false",
  "outbox": "false",
  "syncIssues": "false",
  "litigationHold": "true",
  "inPlaceHold": "true"
}

The above will modify the following:

  • Exclude deleted items
  • Include drafts
  • Include junk e-mail
  • Include outbox items
  • Include sync issues folder
  • Exclude litgation hold items
  • Exclude in place hold items

Email settings

There are 4 different settings related to email.

  • Global e-mail settings “/v4/VBOEmailSettings“
  • Veeam Explorer for Exchange settings “/v4/VexEmailSettings“
  • Veeam Explorer for OneDrive settings “/v4/VeodEmailSettings“
  • Veeam Explorer for SharePoint settings “/v4/VespEmailSettings“

You can perform 3 requests to each one; GET, PUT and POST. If no settings are configured, leverage a POST request to perform the initial setup however if they are already configured, leverage a PUT request to make changes. By performing a GET request, you can see if the e-mail settings are already configured or not.

In general, the options for all 4 are the same and a full list of options is available in the Veeam user guide. In general, there are a few required parameters such as a ‘from‘ and ‘to‘ which determine where to send e-mails and from which sender it will be (for example vbo365admin@mycompany.com). You will also need to configure the mail server and authentication if needed.

History Settings

By default, Veeam Backup for Microsoft Office 365 will log and keep all backup job and restore session however it can be modified to only collect the information for a certain amount of weeks. If you want to adjust this setting, you can perform a “PUT” request via “/v4/HistorySettings“. The example below will change the retention period to only collect data for 26 weeks.

{
  "keepAllsessions": "false",
  "keeponlyLast": 26
}

Missed a part?


Comments are closed.