Veeam ONE 13
REST API Reference
Related documents

Veeam Backup for Microsoft 365 Infrastructure

This resource collection represents monitored Veeam Backup for Microsoft 365 infrastructure.

Get Infrastructure Object Relations

Returns a collection resource representation of all objects in the Veeam Backup for Microsoft 365 infrastructure and their relations.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/vb365/objectRelations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Relations of Infrastructure Object
Returns a resource representation of a Veeam Backup for Microsoft 365 infrastructure object with the specified ID and its relations.


SecurityBearer 
Request 
path Parameters
objectId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/objectRelations/{objectId}
Request samples 
Response samples 
application/json
{
  • "objectId": 1831,
  • "objectName": "repvbm.tech.local",
  • "objectType": "Server",
  • "parentId": 4,
  • "parentName": "Veeam Backup for Microsoft 365",
  • "parentType": "VirtualInfrastructure"
}
Get All Veeam Backup for Microsoft 365 Servers
Returns a collection resource representation of all connected Veeam Backup for Microsoft 365 servers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/servers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup for Microsoft 365 Server
Returns a resource representation of a Veeam Backup for Microsoft 365 server with the specified ID.


SecurityBearer 
Request 
path Parameters
vb365ServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/servers/{vb365ServerId}
Request samples 
Response samples 
application/json
{
  • "vb365ServerId": 1837,
  • "name": "repvbm.tech.local",
  • "version": "7.0.0.2881",
  • "port": 4443,
  • "connectionError": null,
  • "connectionState": "Connected"
}
Get All Proxy Pools
Returns a collection resource representation of all backup proxy pools.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupProxyPools
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Backup Proxy Pool
Returns a resource representation of a backup proxy pool with the specified ID.


SecurityBearer 
Request 
path Parameters
backupProxyPoolId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupProxyPools/{backupProxyPoolId}
Request samples 
Response samples 
application/json
{
  • "backupProxyPoolId": 176,
  • "backupProxyPoolUidInVb365": "6fae69a1-007a-4c82-8867-f5d620f0553a",
  • "name": "365pp1",
  • "vb365ServerId": 162
}
Get All Veeam Backup for Microsoft 365 Backup Proxy Servers
Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup proxy servers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupProxies
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup for Microsoft 365 Backup Proxy Server
Returns a resource representation of a Veeam Backup for Microsoft 365 backup proxy server with the specified ID.


SecurityBearer 
Request 
path Parameters
backupProxyId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupProxies/{backupProxyId}
Request samples 
Response samples 
application/json
{
  • "backupProxyId": 1838,
  • "backupProxyUidInVb365": "c7cecf30-9939-4244-9be1-e111ade6dfec",
  • "backupProxyPoolUid": "33f4ae02-c752-4fa4-b2cf-22e908aa8993",
  • "vb365ServerId": 1837,
  • "type": "Local",
  • "useInternetProxy": true,
  • "internetProxyType": "FromManagementServer",
  • "hostName": "repVBM",
  • "description": "Default backup proxy",
  • "port": 9193,
  • "threadsNumber": 64,
  • "enableNetworkThrottling": false,
  • "status": "Online",
  • "repositoryIds": [
    ]
}
Get All Veeam Backup for Microsoft 365 Backup Repositories
Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup repositories.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupRepositories
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup for Microsoft 365 Backup Repository
Returns a resource representation of a Veeam Backup for Microsoft 365 backup repository with the specified ID.


SecurityBearer 
Request 
path Parameters
backupRepositoryId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/backupRepositories/{backupRepositoryId}
Request samples 
Response samples 
application/json
{
  • "backupRepositoryId": 1839,
  • "backupRepositoryUidInVb365": "ed8f6a13-1fb6-4277-b3cc-cf2c4b7edad2",
  • "name": "Default Backup Repository",
  • "vb365ServerId": 1837,
  • "isOutOfSync": false,
  • "capacityBytes": 85372956672,
  • "freeSpaceBytes": 47251349504,
  • "description": "Created by Veeam Backup for Microsoft 365",
  • "path": "C:\\VeeamRepository",
  • "retentionType": "SnapshotBased",
  • "retentionPeriodType": "Yearly",
  • "retentionDailyPeriod": null,
  • "retentionMonthlyPeriod": null,
  • "retentionYearlyPeriod": 3,
  • "retentionFrequencyType": "Daily",
  • "retentionDailyType": "Everyday",
  • "retentionMonthlyDayNumber": "Unknown",
  • "retentionMonthlyDayOfWeek": "Unknown",
  • "proxyId": 1838,
  • "objectStorageId": null,
  • "objectStorageType": "Unknown",
  • "objectStorageCachePath": null,
  • "isLongTerm": null,
  • "retentionDailyTime": 3600,
  • "retentionMonthlyTime": null
}
Get All Veeam Backup for Microsoft 365 Object Storage Repositories
Returns a collection resource representation of all Veeam Backup for Microsoft 365 object storage repositories.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/objectStorageRepositories
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup for Microsoft 365 Object Storage Repository
Returns a resource representation of a Veeam Backup for Microsoft 365 object storage repository with the specified ID.


SecurityBearer 
Request 
path Parameters
objectStorageRepositoryId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/objectStorageRepositories/{objectStorageRepositoryId}
Request samples 
Response samples 
application/json
{
  • "objectStorageRepositoryId": 186,
  • "objectStorageRepositoryUidInVb365": "2176c43d-fb04-46b7-b812-91fcd3e70e97",
  • "name": "osr2",
  • "vb365ServerId": 162,
  • "folder": "ii",
  • "description": "Created by administrator at 12/10/2022 9:28:21 AM",
  • "accountUid": "ff0e7fdd-7a70-4ece-830d-b62729eaed36",
  • "sizeLimitEnabled": false,
  • "sizeLimitBytes": 0,
  • "usedSpaceBytes": 0,
  • "freeSpaceBytes": null,
  • "type": "WasabiCloud",
  • "glacierDeepArchiveEnabled": null,
  • "iaStorageClassEnabled": null,
  • "useArchiverAppliance": null,
  • "amazonBucketS3CompatibleName": "vbm1-eu-central-1",
  • "amazonBucketS3CompatibleCustomRegionId": "eu-central-1",
  • "amazonBucketS3AwsName": null,
  • "amazonBucketS3AwsRegionType": "Unknown",
  • "amazonBucketS3AwsRegionName": null,
  • "amazonBucketS3AwsRegionId": null,
  • "azureContainerName": null,
  • "azureContainerRegionType": "Unknown"
}
Get All Microsoft Organizations
Returns a collection resource representation of all Microsoft organizations.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft Organization
Returns a resource representation of a Microsoft organization with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}
Request samples 
Response samples 
application/json
{
  • "organizationUid": "71d4090f-a79d-441e-8ad9-dd3cdb1f26f4",
  • "vb365ServerId": 1837,
  • "name": "alpha.onmicrosoft.com",
  • "officeName": "alpha.onmicrosoft.com",
  • "type": "Office365",
  • "region": "Worldwide",
  • "isBackedup": true,
  • "firstBackupTime": "2025-07-06T12:32:05.813Z",
  • "lastBackupTime": "2025-07-06T14:38:36.767Z",
  • "isExchangeOnline": true,
  • "isSharePointOnline": true,
  • "isTeamsOnline": true
}
Get All Users of Microsoft Organization
Returns a collection resource representation of all users of a Microsoft organization with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/users
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft 365 User
Returns a resource representation of a Microsoft 365 user with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
userUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/users/{userUid}
Request samples 
Response samples 
application/json
{
  • "userUid": "d0b1a6e1-1636-5be6-b7d9-e96837d7aa28",
  • "userUidInVb365": "alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:006964f2-5bbb-48aa-84cf-d8766f28bfb6:00000000-0000-0000-0000-000000000000",
  • "name": "vone_user",
  • "email": "vone_user@alpha.onmicrosoft.com",
  • "type": "O365User",
  • "vb365ServerId": 1837,
  • "organizationUid": "71d4090f-a79d-441e-8ad9-dd3cdb1f26f4",
  • "organizationName": "alpha.onmicrosoft.com"
}
Get All Microsoft 365 Users
Returns a collection resource representation of all Microsoft 365 users.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/users
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get All Groups of Microsoft Organization
Returns a collection resource representation of all groups of a Microsoft organization with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/groups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Microsoft 365 Group
Returns a resource representation of a Microsoft 365 group with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
groupUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/groups/{groupUid}
Request samples 
Response samples 
application/json
{
  • "groupUid": "18dc5b69-90db-5cea-aabf-26d155957a8c",
  • "groupUidInVb365": "7xnk2n.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:c7d3150d-d447-4cc6-a202-d1531496808d:00000000-0000-0000-0000-000000000000",
  • "name": "U.S. Sales",
  • "email": "ussales@7xnk2n.onmicrosoft.com",
  • "type": "Office365",
  • "locationType": "Cloud",
  • "managedBy": "Admin1@7xnk2n.onmicrosoft.com",
  • "site": "https://7xnk2n.sharepoint.com/sites/ussales",
  • "vb365ServerId": 193,
  • "organizationUid": "d639627b-bd17-4d19-a1bd-67e6d1c496e0",
  • "organizationName": "FVR"
}
Get All Microsoft 365 Groups
Returns a collection resource representation of all Microsoft 365 groups.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/groups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get SharePoint Sites of Microsoft Organization
Returns a collection resource representation of all Microsoft SharePoint sites of a Microsoft organization with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/sites
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Microsoft SharePoint Site
Returns a resource representation of a Microsoft SharePoint site with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
siteUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/sites/{siteUid}
Request samples 
Response samples 
application/json
{
  • "siteUid": "54905d6b-a280-543b-9c89-037083110f60",
  • "siteUidInVb365": "60145b88-7bad-4a83-8176-1ba814ea90e862051789-6ad1-4d13-88f4-c6a7ea92ecb5",
  • "name": "Lee Gu",
  • "url": "https://llorg.sharepoint.com/personal/llorg_onmicrosoft_com",
  • "vb365ServerId": 162,
  • "organizationUid": "5ffc3579-9e86-4b4f-8f37-e157336a9814",
  • "organizationName": "llorg.onmicrosoft.com",
  • "isCloud": true,
  • "isPersonal": true,
  • "isAvailable": true
}
Get All Microsoft SharePoint Sites
Returns a collection resource representation of all Microsoft SharePoint sites.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/sites
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get All Teams of Microsoft Organization
Returns a collection resource representation of all teams of a Microsoft 365 organization with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/teams
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Microsoft 365 Team
Returns a resource representation of a Microsoft 365 team with the specified UID.


SecurityBearer 
Request 
path Parameters
organizationUid
required
string <uuid> 
 
teamUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/organizations/{organizationUid}/teams/{teamUid}
Request samples 
Response samples 
application/json
{
  • "teamUid": "b74ebb89-8c52-4fb4-b369-2a444a227b16",
  • "name": "Group 1",
  • "description": "Microsoft365",
  • "mail": "group1@llorg.onmicrosoft.com",
  • "vb365ServerId": 162,
  • "organizationUid": "5ffc3579-9e86-4b4f-8f37-e157336a9814",
  • "organizationName": "llorg.onmicrosoft.com"
}
Get All Microsoft 365 Teams
Returns a collection resource representation of all Microsoft 365 teams.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vb365/teams
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}

    
    

                                

                                    
Document updated 9/25/2025
Page content applies to build 13.0.0.5630