- About Veeam Backup for Microsoft 365 REST API
- Overview
- Changelog
- Authorization
- Accounts
- Amazon Archiver Appliance
- Amazon S3 Object Storage Buckets and Folders
- Applications
- Audit
- Audit Email Notification Settings
- Azure Blob Object Storage Containers and Folders
- Azure Service Accounts
- getGet Azure Service Accounts
- postAdd Azure Service Account
- getGet Azure Service Account Properties by Account ID
- putEdit Azure Service Account
- delRemove Azure Service Account
- postGet Device Code
- getGet Subscriptions
- getGet Subscription by ID
- getGet Resource Groups
- getGet Resource Group by Name
- getGet Locations
- getGet Location by Name
- getGet Virtual Machine Sizes
- getGet Virtual Machine Size by Name
- getGet Virtual Networks
- getGet Virtual Network by Name
- getGet Subnets
- getGet Subnet by Name
- Backup Accounts
- Backup and Backup Copy Job Session Operations
- Backup and Backup Copy Job Sessions
- Backup Applications
- Backup Copy Jobs
- Backup Jobs
- getGet Backup Jobs
- postCreate Backup Job
- getGet Backup Job
- putEdit Backup Job Settings
- delRemove Backup Job
- getGet Backup Copy Job
- getGet Backup Job Items
- postAdd Items to Backup Job
- delRemove Backup Job Items
- getGet Backup Job Item
- putEdit Backup Job Item
- getGet Excluded Items
- postAdd Items to Exclusions
- delRemove Excluded Items
- getGet Excluded Item
- putEdit Excluded Item
- postEnable Backup Job
- postDisable Backup Job
- postStart Backup Job
- postStop Backup Job
- postCreate Restore Session
- Backup Proxy Pools
- Backup Proxy Servers
- getGet Backup Proxy Servers
- postAdd Backup Proxy Server
- getGet Backup Proxy Server
- putEdit Backup Proxy Server Settings
- postRescan Backup Proxy Server
- postEnable Maintenance Mode for Backup Proxy Server
- postDisable Maintenance Mode for Backup Proxy Server
- postRemove Backup Proxy Server
- postRescan Backup Proxy Servers
- postCheck SSH Connection
- Backup Repositories
- getGet Backup Repositories
- postAdd Backup Repository
- getGet Backup Repository
- putEdit Backup Repository Settings
- delRemove Backup Repository
- getGet Backed-Up Organizations
- postSynchronize Cache
- postCreate Restore Session for Backup Repository by Repository ID
- postChange Owner for Backup Repository by Repository ID
- Backup Repository Change Owner Sessions
- Backup Repository Synchronization
- Configuration
- Data Protection Reports
- Data Retrieval Jobs
- Data Retrieval Session Operations
- Data Retrieval Sessions
- Encryption Passwords
- Events
- Excluded Mailbox Folders
- Global Exclusions from Retention Policy
- Group Data Backups
- Health
- Internet Proxy Server Settings
- Job Session History Settings
- License
- License Usage Report
- Licensed Users
- Mailbox Data Backups
- Mailbox Folders Restore
- Mailbox Items Restore
- getGet Mailbox Item
- getGet Mailbox Items
- postRestore Mailbox Items to Original Mailbox
- postRestore Mailbox Items to Another Mailbox
- postExport Mailbox Items
- postSave Mailbox Items
- postSend Mailbox Items to Original Mailbox
- postSend Mailbox Items to Another Mailbox
- postRestore Mailbox Item to Original Mailbox
- postRestore Mailbox Item to Another Mailbox
- postExport Mailbox Item
- postSave Mailbox Item
- postSend Mailbox Item to Original Mailbox
- postSend Mailbox Item to Another Mailbox
- postRestore Mailbox Items by Restore Operator
- Mailboxes Restore
- Management Mode
- OneDrive Data Backups
- OneDrive Documents Restore
- getGet OneDrive Documents
- getGet OneDrive Document
- getGet Previous Versions of OneDrive Document
- getGet Specific Version of OneDrive Document
- postRestore OneDrive Documents
- postCopy OneDrive Documents
- postSend OneDrive Documents
- postSave OneDrive Documents
- postRestore OneDrive Document
- postRestore Version of OneDrive Document
- postCopy OneDrive Document
- postCopy Version of OneDrive Document
- postSave OneDrive Document
- postSave Version of OneDrive Document
- postSend OneDrive Document
- postSend Version of OneDrive Document
- postRestore OneDrive Documents by Restore Operator
- OneDrive Folders Restore
- getGet OneDrive Folders
- getGet OneDrive Folder
- postRestore OneDrive Folders
- getGet Specific Version of OneDrive Folder
- postCopy OneDrive Folders
- postSave OneDrive Folders
- postSend OneDrive Folders
- getGet Previous Versions of OneDrive Folder
- postRestore OneDrive Folder
- postRestore Version of OneDrive Folder
- postCopy OneDrive Folder
- postCopy Version of OneDrive Folder
- postSave OneDrive Folder
- postSave Version of OneDrive Folder
- postSend OneDrive Folder
- postSend Version of OneDrive Folder
- postSearch for OneDrive Items in OneDrive Folder
- OneDrives of Organization User
- OneDrives Restore
- Organization Data Backups
- Organization Data Restore
- Organization Exclusions from Retention Policy
- Organization Group Members
- Organization Groups
- Organization Licensing
- Organization Sites
- Organization Teams
- Organization Users
- Organizations
- Processed Objects
- Protected Data
- Restore Operator Roles
- getGet All Restore Operator Roles
- getGet Restore Operator Role
- putEdit Restore Operator Role Settings
- delRemove Restore Operator Role
- getGet Restore Operators
- postAdd Restore Operators
- delRemove Restore Operators
- getGet Restore Operator
- getGet Objects to Manage
- postAdd Objects to Manage
- delRemove Objects to Manage
- getGet Object to Manage
- getGet Excluded Objects
- postAdd Excluded Objects
- delRemove Excluded Objects
- getGet Excluded Object
- getGet Restore Operator Roles by Organization ID
- postAdd Restore Operator Role
- Restore Points
- Restore Portal Settings
- Restore Session Events
- Restore Sessions
- S3 Compatible Object Storage Buckets and Folders
- SharePoint Attachments Restore
- SharePoint Data Backups
- SharePoint Documents Restore
- getGet SharePoint Documents
- getGet SharePoint Document
- getGet Specific Version of SharePoint Document
- getGet Previous Versions of SharePoint Document
- postRestore SharePoint Documents to Original Location
- postRestore SharePoint Documents to Another Location
- postRestore Version of SharePoint Document to Original Location
- postRestore Version of SharePoint Document to Another Location
- postRestore SharePoint Document to Original Location
- postRestore SharePoint Document to Another Location
- postSave SharePoint Documents
- postSave Version of SharePoint Document
- postSave SharePoint Document
- postSend SharePoint Documents
- postSend Version of SharePoint Document
- postSend SharePoint Document
- postRestore SharePoint Documents by Restore Operator
- SharePoint Folders Restore
- getGet SharePoint Folders
- getGet SharePoint Folder
- getGet Specific Version of SharePoint Folder
- getGet Previous Versions of SharePoint Folder
- postRestore SharePoint Folders to Original Location
- postRestore SharePoint Folders to Another Location
- postRestore SharePoint Folder to Original Location
- postRestore SharePoint Folder to Another Location
- postRestore Version of SharePoint Folder to Original Location
- postRestore Version of SharePoint Folder to Another Location
- postSave SharePoint Folders
- postSave SharePoint Folder
- postSave Version of SharePoint Folder
- postSend SharePoint Folders
- postSend SharePoint Folder
- postSend Version of SharePoint Folder
- postSearch for SharePoint Documents in SharePoint Folder
- SharePoint Items Restore
- getGet SharePoint Items
- getGet SharePoint Item
- getGet Specific Version of SharePoint Item
- getGet Previous Versions of SharePoint Item
- postRestore SharePoint Items to Original Location
- postRestore SharePoint Items to Another Location
- postRestore SharePoint Item to Original Location
- postRestore Version of SharePoint Item to Original Location
- postRestore SharePoint Item to Another Location
- postRestore Version of SharePoint Item to Another Location
- postRestore SharePoint Items by Restore Operator
- SharePoint Libraries Restore
- SharePoint Lists Restore
- SharePoint Sites Restore
- Synchronization of Organization Objects
- Team Data Backups
- Teams Channels Restore
- Teams Files Restore
- Teams Posts Restore
- Teams Restore
- Teams Tabs Restore
- User Data Backups
- Users Logged In to Restore Portal
- Veeam Backup for Microsoft 365 Email Notification Settings
- Veeam Explorer for Microsoft Exchange Email Settings
- Veeam Explorer for Microsoft OneDrive for Business Email Settings
- Veeam Explorer for Microsoft SharePoint Email Settings
- Veeam Explorer for Microsoft Teams Email Settings
- Version and Installation ID
The /EncryptionKeys resource collection allows you to manage passwords that Veeam Backup for Microsoft 365 uses to encrypt data that is being transferred to object storage repository.
Get Encryption Passwords
Returns a list of existing encryption passwords.
SecurityBearer
Request
query Parameters
| description | string Specifies the hint of the encryption password. |
| organizationId | string <uuid> Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations. |
Responses
200
OK
default
Operation failure response.
get/v8/EncryptionKeys
Request samples
- curl
- Python
- JavaScript
- C#
- Go
Response samples
- 200
- default
application/json
[- {
- "id": "00000000-0000-0000-0000-000000000000",
- "description": "string",
- "organizationId": "00000000-0000-0000-0000-000000000000",
- "_links": {
- "property1": {
- "href": "string"
}, - "property2": {
- "href": "string"
}
}
}
]Add Encryption Password
Adds a new encryption password.
x-codegen-request-body-name: encryptionKey
SecurityBearer
Request
Request Body schema: application/jsonrequired
| password | string <password> (SecureString) Specifies a password. |
| newPassword | string <password> (SecureString) Specifies a password. |
| oldPassword | string <password> (SecureString) Specifies a password. |
| id | string or null <uuid> Specifies the encryption password ID. |
| organizationId | string or null <uuid> Specifies the organization ID. |
| description | string Specifies the hint of the encryption password. |
object (RESTLinkHALDictionary) Related resources. |
Responses
201
Created
default
Operation failure response.
post/v8/EncryptionKeys
Request samples
- Payload
- curl
- Python
- JavaScript
- C#
- Go
application/json
{- "password": "pa$$word",
- "newPassword": "pa$$word",
- "oldPassword": "pa$$word",
- "id": "00000000-0000-0000-0000-000000000000",
- "organizationId": "00000000-0000-0000-0000-000000000000",
- "description": "string",
- "_links": {
- "property1": {
- "href": "string"
}, - "property2": {
- "href": "string"
}
}
}Response samples
- 201
- default
application/json
{- "id": "00000000-0000-0000-0000-000000000000",
- "description": "string",
- "organizationId": "00000000-0000-0000-0000-000000000000",
- "_links": {
- "property1": {
- "href": "string"
}, - "property2": {
- "href": "string"
}
}
}Get Encryption Password Properties
Returns properties of an encryption password with the specified ID.
SecurityBearer
Request
path Parameters
| keyId required | string <uuid> Specifies the identification number of the encryption password. For more information on how to get this parameter, see Get Encryption Passwords. |
Responses
200
OK
default
Operation failure response.
get/v8/EncryptionKeys/{keyId}
Request samples
- curl
- Python
- JavaScript
- C#
- Go
Response samples
- 200
- default
application/json
{- "id": "00000000-0000-0000-0000-000000000000",
- "description": "string",
- "organizationId": "00000000-0000-0000-0000-000000000000",
- "_links": {
- "property1": {
- "href": "string"
}, - "property2": {
- "href": "string"
}
}
}Remove Encryption Password
Removes an encryption password with the specified ID from the Veeam Backup for Microsoft 365 database.
SecurityBearer
Request
path Parameters
| keyId required | string <uuid> Specifies the identification number of the encryption password. For more information on how to get this parameter, see Get Encryption Passwords. |
Responses
204
No Content
default
Operation failure response.
delete/v8/EncryptionKeys/{keyId}
Request samples
- curl
- Python
- JavaScript
- C#
- Go
Response samples
- default
application/json
{- "message": "string",
- "errorCode": "ProxyOffline",
- "stackTrace": "string"
}