Veeam Backup for Microsoft Office 365 5.0
REST API Reference

Related documents

User Guide PowerShell Reference Veeam Explorers User Guide Veeam Explorers PowerShell Reference

Search

Veeam Backup for Microsoft Office 365 5.0
REST API Reference

Overview

Enabling REST API Service
Resource URLs
Authorization and Security

Authorization for Organizations with Modern App-Only Authentication

Methods

GET Method
POST Method
PUT Method
DELETE Method

Pagination
Search for Backed-Up Items
Evaluation in Swagger UI

API Reference

Backup Proxy Servers

Managing Proxy Servers

Getting Backup Proxy Servers
Adding Backup Proxy Servers
Rescanning Backup Proxy Servers

Managing Proxy Servers by Proxy Server ID

Getting Backup Proxy Servers
Editing Backup Proxy Server Settings
Rescanning Backup Proxy Servers
Removing Backup Proxy Servers

Managing Internet Proxy Servers

Getting Internet Proxy Server
Editing Internet Proxy Server Settings

Backup Repositories

Managing Backup Repositories

Getting Backup Repositories
Adding Backup Repositories

Managing Backup Repositories by ID

Getting Backup Repositories
Editing Backup Repository Settings
Removing Backup Repositories

Getting Backed-Up Organizations
Getting Organization Data by Repository ID
Getting Organization Data by Repository and Organization ID
Getting List of Users by Repository ID
Getting User Data by Repository and User ID
Getting SharePoint Data by Repository ID
Getting SharePoint Data by Repository and Site ID
Getting Group Data by Repository ID
Getting Group Data by Repository and Group ID
Getting Teams Data by Repository ID
Getting Teams Data by Repository and Team ID
Data Synchronization

Synchronizing Repositories
Getting Synchronization Sessions
Getting Synchronization Session Statistics
Stopping Synchronization Session

Object Storage Repositories

Managing Cloud Credentials

Getting Accounts
Getting Account Properties by Account ID
Adding Accounts
Editing Accounts
Removing Accounts

Managing Encryption Passwords

Getting Passwords
Getting Password Properties by Password ID
Adding Passwords
Editing Passwords
Removing Passwords

Getting Object Storage Repositories
S3 Compatible and IBM Object Storage

Getting Object Storage by ID
Adding Object Storage
Editing Object Storage by ID
Removing Object Storage
Getting Buckets
Managing Folders

Getting Folders
Creating Folders

Amazon S3 Object Storage

Getting Object Storage by ID
Adding Object Storage
Editing Object Storage by ID
Removing Object Storage
Getting Buckets
Managing Folders

Getting Folders
Creating Folders

Azure Blob Storage

Getting Object Storage by ID
Adding Object Storage
Editing Object Storage by ID
Removing Object Storage
Getting Containers
Managing Folders

Getting Folders
Creating Folders

Organizations

Getting Organization
Getting Organizations
Getting Organization Parameters
Adding Organizations

Microsoft Office 365 Organizations

Organizations with Modern App-Only Authentication

Getting Device Code

Organizations with Modern Authentication and Legacy Protocols
Organizations with Basic Authentication

On-Premises Organizations
Hybrid Organizations

Removing Organizations
Editing Organization Parameters
Getting Organization Repositories
Creating Restore Session for Organization
Creating Restore Session for Organization by Organization ID
Managing Backup Accounts

Getting Backup Accounts
Adding Backup Accounts

Managing Backup Applications

Getting Applications from Azure
Getting Configured Applications
Getting Device Code
Adding Backup Applications
Creating Applications in Azure

Managing Exclusions

Getting Excluded Items
Editing Excluded Items
Removing Excluded Items

Managing Audit Items

Getting Audit Items
Creating Audit Items
Removing Audit Items

Getting License Information
Getting Organization Groups
Getting Organization Groups by Organization and Group ID
Getting Organization Group Members
Getting Microsoft SharePoint Sites
Getting Microsoft SharePoint Sites by Organization and Site ID
Getting Organization Users
Getting Organization Users by Organization and User ID
Getting OneDrives
Getting OneDrives by OneDrive ID
Getting Teams
Getting Teams by Organization and Team ID

Backup Jobs

Getting Backup Jobs
Managing Backup Jobs by Organization ID

Getting Backup Jobs
Creating Backup Jobs

Managing Backup Jobs by Job ID

Getting Backup Jobs
Editing Backup Job Settings
Removing Backup Jobs
Managing Backup Jobs

Managing Items in Backup Jobs by Job ID

Getting Backup Job Items
Adding Items to Backup Job

Managing Items in Backup Jobs by Item ID

Getting Backup Job Items
Editing Backup Job Items
Removing Backup Job Items

Managing Folders Exclusions

Getting Excluded Folders
Editing Exclusion Settings

Managing Excluded Items by Job ID

Getting Excluded Items
Adding Items to Exclusion List

Managing Excluded Items by Item ID

Getting Excluded Items
Editing Excluded Items
Removing Excluded Items

Getting Backup Job Sessions
Getting Backup Job Session by Job ID
Getting Backup Job Session by Session ID
Getting Information on Operations by Session ID
Getting Information on Operation by LogItem ID
Managing Backup Job Sessions History Settings

Getting Backup Job Sessions History Settings
Editing Backup Job Sessions History Settings

Data Restore

Getting Restore Sessions
Getting Device Code
Managing Restore Sessions by Session ID

Getting Restore Sessions
Stopping Restore Sessions

Getting Restore Session Events
Getting Restore Session Event by Event ID
Managing Organization Backups

Getting Organization Backups for Restore
Exporting Data to PST
Searching for Teams Items in Organization Backups

Managing Mailboxes

Getting Mailboxes
Performing Bulk Restore of Mailbox Data

Managing Mailboxes by Mailbox ID

Getting Mailboxes
Exporting and Restoring Mailbox Data
Searching for Exchange Items in Mailboxes

Getting Mailbox Folders
Managing Mailbox Folders by Folder ID

Getting Mailbox Folders
Exporting and Restoring Data from Folders
Searching for Exchange Items in Mailbox Folders

Managing Mailbox Items

Getting Mailbox Items
Exporting, Restoring, Sending and Saving Mailbox Items

Managing Mailbox Items by Item ID

Getting Mailbox Items
Exporting, Restoring, Sending and Saving Mailbox Items

Managing OneDrive Items

Getting OneDrive Items
Performing Bulk Restore of OneDrive Items

Managing OneDrive Items by OneDrive ID

Getting OneDrive Items
Sending, Saving, Copying and Restoring OneDrive Items
Searching for OneDrive Items in OneDrive

Managing OneDrive Documents

Getting OneDrive Documents
Sending, Saving, Copying and Restoring OneDrive Documents

Managing OneDrive Documents by Document ID

Getting OneDrive Documents
Sending, Saving, Copying and Restoring OneDrive Documents

Managing OneDrive Folders

Getting OneDrive Folders
Sending, Saving, Copying and Restoring OneDrive Folders

Managing OneDrive Folders by Folder ID

Getting OneDrive Folders
Sending, Saving, Copying and Restoring OneDrive Folders
Searching for OneDrive Items in OneDrive Folders

Getting Organization SharePoint Sites
Managing SharePoint Sites by Site ID

Getting SharePoint Sites
Restoring SharePoint Sites
Searching for SharePoint Items in SharePoint Sites

Managing SharePoint Documents

Getting SharePoint Documents
Restoring, Saving and Sending SharePoint Documents

Managing SharePoint Documents by Document ID

Getting SharePoint Documents
Restoring, Saving and Sending SharePoint Documents

Managing SharePoint Folders

Getting SharePoint Folders
Restoring, Saving and Sending SharePoint Folders

Managing SharePoint Folders by Folder ID

Getting SharePoint Folders
Restoring, Saving and Sending SharePoint Folders
Searching for SharePoint Documents in SharePoint Folders

Managing SharePoint Items

Getting SharePoint Items
Restoring SharePoint Items

Managing SharePoint Items by Item ID

Getting SharePoint Items
Restoring SharePoint Items

Managing SharePoint Attachments

Getting SharePoint Attachments
Sending and Saving SharePoint Attachments

Managing SharePoint Attachments by Attachment ID

Getting SharePoint Attachments
Sending and Saving SharePoint Attachments

Getting SharePoint Libraries
Managing SharePoint Libraries by Library ID

Getting SharePoint Libraries
Restoring, Sending and Saving SharePoint Libraries
Searching for SharePoint Documents in SharePoint Libraries

Getting SharePoint Lists
Managing SharePoint Lists by List ID

Getting SharePoint Lists
Restoring SharePoint Lists
Searching for SharePoint Items in SharePoint Lists

Managing Teams

Getting Teams
Performing Bulk Restore of Teams

Managing Teams by Team ID

Getting Teams
Restoring Teams
Searching for Teams Items in Teams

Getting Teams Channels
Managing Teams Channels by Channel ID

Getting Channels
Restoring Channels
Searching for Teams Items in Channels

Managing Teams Tabs

Getting Tabs
Restoring Tabs
Searching for Tabs

Managing Teams Tabs by Tab ID

Getting Tabs
Restoring Tabs

Managing Teams Files

Getting Files
Restoring, Sending and Saving Files
Searching for Files

Managing Teams Files by File ID

Getting Files
Restoring, Sending and Saving Files

Managing Teams Posts

Getting Posts
Exporting, Restoring, Sending and Saving Posts
Searching for Posts

Managing Teams Posts by Post ID

Getting Posts
Exporting, Sending and Saving Posts

Managing Global Exclusions from Retention Policy

Getting Excluded Items
Editing Exclusion Settings

Managing Notification Settings

Getting Notification Settings
Editing Notification Settings
Sending Test Message
Veeam Explorer for Microsoft Exchange Notifications

Getting Notification Settings
Editing Notification Settings
Sending Test Message

Veeam Explorer for Microsoft SharePoint Notifications

Getting Notification Settings
Editing Notification Settings
Sending Test Message

Veeam Explorer for Microsoft OneDrive for Business Notifications

Getting Notification Settings
Editing Notification Settings
Sending Test Message

Veeam Explorer for Microsoft Teams Notifications

Getting Notification Settings
Editing Notification Settings
Sending Test Message

Managing Audit Notification Settings

Getting Audit Notification Settings
Editing Audit Notification Settings
Sending Test Message

Managing License

Getting License
Installing and Updating License
Viewing License Usage Report

Managing Licensed Users

Getting Licensed Users
Revoking License from Users

Generating Data Protection Reports

Deprecated Resources
Appendix A. Item Search Parameters
Appendix B. REST API v5.0 Changelog

Global Changes
Resource Changes
Breaking Changes
New Operations

>REST API Reference>Deprecated Resources

Deprecated Resources

In this article

Versions v1 and v2 of Veeam Backup for Microsoft Office 365 REST API resources are deprecated in Veeam Backup for Microsoft Office 365 5.0.

Page updated 3/19/2021

Send feedback

Home | Products | Forums | Support | Contact Sales | EULA

©2021 Veeam® Software Privacy Policy & Cookies

This document
Help Center

I want to report a typo

There is a misspelling right here:

I want to let the Veeam Documentation Team know about that.

Submit report