Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Jobs

The /Jobs resource collection represents backup jobs created for Microsoft organizations and allows you to create and manage backup jobs.

Get Backup Jobs

Returns a collection of configured backup jobs.

SecurityBearer
Request
query Parameters
organizationId
string <uuid>

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

repositoryId
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/Jobs
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Create Backup Job
Creates a backup job for an organization with the specified ID.


x-codegen-request-body-name:  restJob
SecurityBearer 
Request 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
repositoryId
required
string <uuid> 
Backup repository ID.


 
organizationId
required
string <uuid> 
ID of the Microsoft 365 organization.


 
backupType
required
string
Type of the backup job.


 Enum: "EntireOrganization" "SelectedItems"  
description
string
Description of the backup job.


 
runNow
boolean or null
Defines whether the job will run right after it is created.


 
Array of objects (RESTJobItemComposed) 
Array of objects that you want to back up.


 
Array of objects (RESTJobItemComposed) 
Array of objects that you want to exclude from a backup job scope.


 
object (RESTJobSchedulePolicy) 
 
name
string
Name of the backup job.


 
isEnabled
boolean or null
Defines whether the backup job is enabled.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Jobs
Request samples 
application/json
{
  • "description": "string",
  • "backupType": "EntireOrganization",
  • "runNow": true,
  • "selectedItems": [
    ],
  • "excludedItems": [
    ],
  • "schedulePolicy": {
    },
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "isEnabled": true
}
Response samples 
application/json
{
  • "description": "string",
  • "backupType": "EntireOrganization",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "totalObjects": 0,
  • "processedObjects": 0,
  • "eTag": 0,
  • "_links": {
    }
}
Get Backup Job
Returns a resource representation of a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}
Request samples 
Response samples 
application/json
{
  • "description": "string",
  • "backupType": "EntireOrganization",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "totalObjects": 0,
  • "processedObjects": 0,
  • "eTag": 0,
  • "_links": {
    }
}
Edit Backup Job Settings
Modifies settings of a backup job with the specified ID.


x-codegen-request-body-name:  restJob
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
description
string or null
Description of the backup job.


 
backupType
string or null
Type of the backup job.


 Enum: "EntireOrganization" "SelectedItems"  
runNow
boolean or null
Defines whether the job will run right after it is created.


 
Array of objects or null (RESTJobItemComposed) 
Array of objects that you want to back up.


 
Array of objects or null (RESTJobItemComposed) 
Array of objects that you want to exclude from a backup job scope.


 
object (RESTJobSchedulePolicy) 
 
repositoryId
string or null <uuid> 
Backup repository ID.


 
name
string or null
Name of the backup job.


 
isEnabled
boolean or null
Defines whether the backup job is enabled.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Jobs/{jobId}
Request samples 
application/json
{
  • "description": "string",
  • "backupType": "EntireOrganization",
  • "runNow": true,
  • "selectedItems": [
    ],
  • "excludedItems": [
    ],
  • "schedulePolicy": {
    },
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "isEnabled": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Job
Removes a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/Jobs/{jobId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Backup Copy Job
Returns a resource representation of a backup copy job created for the backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}/CopyJob
Request samples 
Response samples 
application/json
{
  • "backupJobId": "00000000-0000-0000-0000-000000000000",
  • "schedulePolicy": {
    },
  • "id": "00000000-0000-0000-0000-000000000000",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "lastRun": "2019-08-24T14:15:22Z",
  • "nextRun": "2019-08-24T14:15:22Z",
  • "lastBackup": "2019-08-24T14:15:22Z",
  • "isEnabled": true,
  • "lastStatus": "Stopped",
  • "eTag": 0,
  • "_links": {
    }
}
Get Backup Job Items
Returns a resource representation of items added to a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}/SelectedItems
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Items to Backup Job
Adds items to the processing list of a backup job with the specified ID.


x-codegen-request-body-name:  itemsToAppend
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
 Array 
type
string (RESTJobBackupItemType) 
Type of the backup item.


 Enum: "Group" "User" "Site" "PartialOrganization" "PersonalSites" "OneDriveFolders" "Team"  
folders
Array of strings
Array of OneDrive folders included in/excluded from the backup job.


Note: This property applies to all OneDrives in an organization. Only specified folders will be processed for each OneDrive.


 
id
string or null
Backup item ID.


Note: This complex ID comprises the combination of the unchangeable identificator of an object type in Veeam Backup for Microsoft 365 and ID of a particular object. Unchangeable identificators have different values depending on an object type. You can use the following values to recognize objects of a particular type in the response: 
     
  • 2b38d840-8098-4614-b369-ebce33f9b2c7 - for organization users.
    •  
  • 9592732d-22d8-426a-8167-d9635158e945 - for organization groups.
    •  
  • e1fa728c-4150-4724-ab3b-5deda33db0cf - for organization sites.
    •  
  • c37da450-6c4b-48c4-87e2-cc557ef5d897 - for organizations.
    •  
  • 9a01bcb3-d2de-4271-96bb-95611ddc70b3 - for personal sites.
    •  
  • 7f07820e-9e77-4beb-92a3-b31f30bc192c - for OneDrive folders.
    •  
  • 7B985334-BC0E-4791-B30C-D03A1FECC840 - for teams.
    •  


 
mailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
oneDrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
archiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
sites
boolean or null
Defines whether this backup job will include/exclude the Sites processing option.


 
teams
boolean or null
Defines whether this backup job will include/exclude the Teams processing option.


 
teamsChats
boolean or null
Defines whether this job will back up team chats.


 
object (RESTJobSite) 
 
object (RESTTeam) 
 
object (RESTUser) 
 
personalSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
object (RESTGroup) 
 
members
boolean or null
Defines whether this backup job will include/exclude the Members processing option.


 
memberMailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
memberArchiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
memberOnedrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
memberSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
groupSite
boolean or null
Defines whether this job will back up a group site.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Jobs/{jobId}/SelectedItems
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Job Items
Removes specified backup items from a backup job with the specified ID.


Note: You you can specify the backup item IDs either in query or in the request body.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
ids
string
Specifies IDs of the items that you want to remove from the backup job processing list. For more information on how to get such IDs, see Get Backup Job Items. To specify multiple items, use comma.


 
Request Body schema: application/json
 Array 
string
Specifies an array of IDs of the items that you want to remove from the backup job processing list. For more information on how to get such IDs, see Get Backup Job Items.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/Jobs/{jobId}/SelectedItems
Request samples 
application/json
[
  • "string"
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Backup Job Item
Returns a resource representation of a backup item with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
itemId
required
string
Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Get Backup Job Items.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}/SelectedItems/{itemId}
Request samples 
Response samples 
application/json
{
  • "type": "Group",
  • "folders": [
    ],
  • "id": "string",
  • "_links": {
    },
  • "mailbox": true,
  • "oneDrive": true,
  • "archiveMailbox": true,
  • "sites": true,
  • "teams": true,
  • "teamsChats": true,
  • "site": {
    },
  • "team": {
    },
  • "user": {
    },
  • "personalSite": true,
  • "group": {
    },
  • "members": true,
  • "memberMailbox": true,
  • "memberArchiveMailbox": true,
  • "memberOnedrive": true,
  • "memberSite": true,
  • "groupSite": true
}
Edit Backup Job Item
Modifies a backup item with the specified ID.


x-codegen-request-body-name:  itemsToUpdate
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
itemId
required
string
Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Get Backup Job Items.


 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
type
string (RESTJobBackupItemType) 
Type of the backup item.


 Enum: "Group" "User" "Site" "PartialOrganization" "PersonalSites" "OneDriveFolders" "Team"  
folders
Array of strings
Array of OneDrive folders included in/excluded from the backup job.


Note: This property applies to all OneDrives in an organization. Only specified folders will be processed for each OneDrive.


 
id
string or null
Backup item ID.


Note: This complex ID comprises the combination of the unchangeable identificator of an object type in Veeam Backup for Microsoft 365 and ID of a particular object. Unchangeable identificators have different values depending on an object type. You can use the following values to recognize objects of a particular type in the response: 
     
  • 2b38d840-8098-4614-b369-ebce33f9b2c7 - for organization users.
    •  
  • 9592732d-22d8-426a-8167-d9635158e945 - for organization groups.
    •  
  • e1fa728c-4150-4724-ab3b-5deda33db0cf - for organization sites.
    •  
  • c37da450-6c4b-48c4-87e2-cc557ef5d897 - for organizations.
    •  
  • 9a01bcb3-d2de-4271-96bb-95611ddc70b3 - for personal sites.
    •  
  • 7f07820e-9e77-4beb-92a3-b31f30bc192c - for OneDrive folders.
    •  
  • 7B985334-BC0E-4791-B30C-D03A1FECC840 - for teams.
    •  


 
mailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
oneDrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
archiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
sites
boolean or null
Defines whether this backup job will include/exclude the Sites processing option.


 
teams
boolean or null
Defines whether this backup job will include/exclude the Teams processing option.


 
teamsChats
boolean or null
Defines whether this job will back up team chats.


 
object (RESTJobSite) 
 
object (RESTTeam) 
 
object (RESTUser) 
 
personalSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
object (RESTGroup) 
 
members
boolean or null
Defines whether this backup job will include/exclude the Members processing option.


 
memberMailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
memberArchiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
memberOnedrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
memberSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
groupSite
boolean or null
Defines whether this job will back up a group site.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Jobs/{jobId}/SelectedItems/{itemId}
Request samples 
application/json
{
  • "type": "Group",
  • "folders": [
    ],
  • "id": "string",
  • "mailbox": true,
  • "oneDrive": true,
  • "archiveMailbox": true,
  • "sites": true,
  • "teams": true,
  • "teamsChats": true,
  • "site": {
    },
  • "team": {
    },
  • "user": {
    },
  • "personalSite": true,
  • "group": {
    },
  • "members": true,
  • "memberMailbox": true,
  • "memberArchiveMailbox": true,
  • "memberOnedrive": true,
  • "memberSite": true,
  • "groupSite": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Excluded Items
Returns a resource representation of items excluded from a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
limit
integer <int32> 
Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.


 
offset
integer <int32> 
Excludes from a response page the first N items of a collection resource. The default value is 0.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}/ExcludedItems
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Items to Exclusions
Excludes items from a backup job with the specified ID.


x-codegen-request-body-name:  itemsToAppend
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
 Array 
type
string (RESTJobBackupItemType) 
Type of the backup item.


 Enum: "Group" "User" "Site" "PartialOrganization" "PersonalSites" "OneDriveFolders" "Team"  
folders
Array of strings
Array of OneDrive folders included in/excluded from the backup job.


Note: This property applies to all OneDrives in an organization. Only specified folders will be processed for each OneDrive.


 
id
string or null
Backup item ID.


Note: This complex ID comprises the combination of the unchangeable identificator of an object type in Veeam Backup for Microsoft 365 and ID of a particular object. Unchangeable identificators have different values depending on an object type. You can use the following values to recognize objects of a particular type in the response: 
     
  • 2b38d840-8098-4614-b369-ebce33f9b2c7 - for organization users.
    •  
  • 9592732d-22d8-426a-8167-d9635158e945 - for organization groups.
    •  
  • e1fa728c-4150-4724-ab3b-5deda33db0cf - for organization sites.
    •  
  • c37da450-6c4b-48c4-87e2-cc557ef5d897 - for organizations.
    •  
  • 9a01bcb3-d2de-4271-96bb-95611ddc70b3 - for personal sites.
    •  
  • 7f07820e-9e77-4beb-92a3-b31f30bc192c - for OneDrive folders.
    •  
  • 7B985334-BC0E-4791-B30C-D03A1FECC840 - for teams.
    •  


 
mailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
oneDrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
archiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
sites
boolean or null
Defines whether this backup job will include/exclude the Sites processing option.


 
teams
boolean or null
Defines whether this backup job will include/exclude the Teams processing option.


 
teamsChats
boolean or null
Defines whether this job will back up team chats.


 
object (RESTJobSite) 
 
object (RESTTeam) 
 
object (RESTUser) 
 
personalSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
object (RESTGroup) 
 
members
boolean or null
Defines whether this backup job will include/exclude the Members processing option.


 
memberMailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
memberArchiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
memberOnedrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
memberSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
groupSite
boolean or null
Defines whether this job will back up a group site.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Jobs/{jobId}/ExcludedItems
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Excluded Items
Removes specified items from items excluded from a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
query Parameters
ids
required
string
Specifies IDs of the items that you want to remove from the list of exclusions. For more information on how to get such IDs, see Get Excluded Items. To specify multiple items, use comma.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/Jobs/{jobId}/ExcludedItems
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Excluded Item
Returns a resource representation of an excluded item with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
itemId
required
string
Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Get Excluded Items.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Jobs/{jobId}/ExcludedItems/{itemId}
Request samples 
Response samples 
application/json
{
  • "type": "Group",
  • "folders": [
    ],
  • "id": "string",
  • "_links": {
    },
  • "mailbox": true,
  • "oneDrive": true,
  • "archiveMailbox": true,
  • "sites": true,
  • "teams": true,
  • "teamsChats": true,
  • "site": {
    },
  • "team": {
    },
  • "user": {
    },
  • "personalSite": true,
  • "group": {
    },
  • "members": true,
  • "memberMailbox": true,
  • "memberArchiveMailbox": true,
  • "memberOnedrive": true,
  • "memberSite": true,
  • "groupSite": true
}
Edit Excluded Item
Modifies an excluded item with the specified ID. 
NOTE 
 You cannot edit properties for an excluded item of the Team or Site type. 


x-codegen-request-body-name:  itemsToUpdate
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
itemId
required
string
Specifies the identification number of the item in the backup file. For more information on how to get this parameter, see Get Excluded Items.


 
query Parameters
skipItemUpdate
boolean
Defines whether to ignore updates for properties of the objects that you want to back up or exclude from a backup job scope.


 
Request Body schema: application/json
required
type
string (RESTJobBackupItemType) 
Type of the backup item.


 Enum: "Group" "User" "Site" "PartialOrganization" "PersonalSites" "OneDriveFolders" "Team"  
folders
Array of strings
Array of OneDrive folders included in/excluded from the backup job.


Note: This property applies to all OneDrives in an organization. Only specified folders will be processed for each OneDrive.


 
id
string or null
Backup item ID.


Note: This complex ID comprises the combination of the unchangeable identificator of an object type in Veeam Backup for Microsoft 365 and ID of a particular object. Unchangeable identificators have different values depending on an object type. You can use the following values to recognize objects of a particular type in the response: 
     
  • 2b38d840-8098-4614-b369-ebce33f9b2c7 - for organization users.
    •  
  • 9592732d-22d8-426a-8167-d9635158e945 - for organization groups.
    •  
  • e1fa728c-4150-4724-ab3b-5deda33db0cf - for organization sites.
    •  
  • c37da450-6c4b-48c4-87e2-cc557ef5d897 - for organizations.
    •  
  • 9a01bcb3-d2de-4271-96bb-95611ddc70b3 - for personal sites.
    •  
  • 7f07820e-9e77-4beb-92a3-b31f30bc192c - for OneDrive folders.
    •  
  • 7B985334-BC0E-4791-B30C-D03A1FECC840 - for teams.
    •  


 
mailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
oneDrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
archiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
sites
boolean or null
Defines whether this backup job will include/exclude the Sites processing option.


 
teams
boolean or null
Defines whether this backup job will include/exclude the Teams processing option.


 
teamsChats
boolean or null
Defines whether this job will back up team chats.


 
object (RESTJobSite) 
 
object (RESTTeam) 
 
object (RESTUser) 
 
personalSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
object (RESTGroup) 
 
members
boolean or null
Defines whether this backup job will include/exclude the Members processing option.


 
memberMailbox
boolean or null
Defines whether this backup job will include/exclude the Mail processing option.


 
memberArchiveMailbox
boolean or null
Defines whether this backup job will include/exclude the Archive processing option.


 
memberOnedrive
boolean or null
Defines whether this backup job will include/exclude the OneDrive processing option.


 
memberSite
boolean or null
Defines whether this backup job will include/exclude the Site processing option.


 
groupSite
boolean or null
Defines whether this job will back up a group site.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Jobs/{jobId}/ExcludedItems/{itemId}
Request samples 
application/json
{
  • "type": "Group",
  • "folders": [
    ],
  • "id": "string",
  • "mailbox": true,
  • "oneDrive": true,
  • "archiveMailbox": true,
  • "sites": true,
  • "teams": true,
  • "teamsChats": true,
  • "site": {
    },
  • "team": {
    },
  • "user": {
    },
  • "personalSite": true,
  • "group": {
    },
  • "members": true,
  • "memberMailbox": true,
  • "memberArchiveMailbox": true,
  • "memberOnedrive": true,
  • "memberSite": true,
  • "groupSite": true
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Enable Backup Job
Enables a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Jobs/{jobId}/enable
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Disable Backup Job
Disables a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Jobs/{jobId}/disable
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Start Backup Job
Starts a backup job with the specified ID.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Request Body schema: application/json
required
full
boolean
Defines whether the backup job will create an active full backup.


 
Responses 
200
OK


default
Operation failure response.


post/v8/Jobs/{jobId}/start
Request samples 
application/json
{
  • "full": true
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "jobId": "00000000-0000-0000-0000-000000000000",
  • "repositoryId": "00000000-0000-0000-0000-000000000000",
  • "mainSessionId": "00000000-0000-0000-0000-000000000000",
  • "details": "string",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "retryCount": 0,
  • "jobWillBeRetried": true,
  • "progress": 0,
  • "total": 0,
  • "jobType": "Backup",
  • "jobSessionConfigType": "Full",
  • "status": "Stopped",
  • "statistics": {
    },
  • "eTag": 0,
  • "_links": {
    },
  • "proxyId": "00000000-0000-0000-0000-000000000000",
  • "proxyPoolId": "00000000-0000-0000-0000-000000000000"
}
Stop Backup Job
Stops a backup job with the specified ID.


SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Jobs/{jobId}/stop
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Create Restore Session
Creates and starts a restore session for a backup job with the specified ID.


The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organizations/{organizationId} resource inform you when the organization data was backed up for the first and last times. For more information, see Get Organization by Organization ID.


Mind the following: 
     
  • If you specify the point in time which precedes the organization first backup time, the restore session will be created with no backup data for explore or restore.
    •  
  • If you specify the point in time which exceeds the organization last backup time, the restore session will be created with backup data as of the latest restore point.
    •  


x-codegen-request-body-name:  exploreOptions
SecurityBearer 
Request 
path Parameters
jobId
required
string <uuid> 
Specifies the identification number of the backup job. For more information on how to get this parameter, see Get Backup Jobs.


 
Request Body schema: application/json
required
dateTime
string or null <date-time> 
Specifies the date and time.


 
type
string or null
Specifies a type of the restore session to start.


 Enum: "Vex" "Veod" "Vesp" "Vet"  
showDeleted
boolean or null
Defines whether the restore session will show items that have been removed by the user before the specified date.


 
showAllVersions
boolean or null
Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Jobs/{jobId}/explore
Request samples 
application/json
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "type": "Vex",
  • "showDeleted": true,
  • "showAllVersions": true
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201