Veeam Service Provider Console 9.1
REST API Reference
Related documents

Veeam Backup for Microsoft 365 Server

This resource collection represents information on Veeam Backup for Microsoft 365 integration.

Get All Unactivated Veeam Backup for Microsoft 365 Servers.

Returns a collection resource representation of all unactivated Veeam Backup for Microsoft 365 servers.

Request
query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/infrastructure/unactivatedVb365Servers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Unactivated Veeam Backup for Microsoft 365 Server
Returns an resource representation of an Unactivated Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
uniqueUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/unactivatedVb365Servers/{uniqueUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Activate Unactivated Veeam Backup for Microsoft 365 Server
Activates an unactivated Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
uniqueUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/unactivatedVb365Servers/{uniqueUid}/activate
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Connected Veeam Backup fot Microsoft 365 Servers.
Returns a collection resource representation of all connected Veeam Backup for Microsoft 365 servers.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Organizations
Returns a collection resource representation of all Microsoft organizations.




Does not include hybrid and on-premises organizations.




Request 
query Parameters
expand
Array of strings (Vb365OrganizationBaseExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "OrganizationDetails" "Vb365Server"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
siteFilter
Array of strings or null <uuid> 
Specifies the list of Veeam Cloud Connect site UIDs that limits the resources to the ones associated with those sites.


 
organizationFilter
string or null <uuid> 
Specifies the list of organization UIDs that limits the resources to the ones associated with those organizations.


 
locationFilter
string or null <uuid> 
Specifies the list of location UIDs that limits the resources to the ones associated with those locations.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Organization Mappings to Companies
Returns a collection resource representation of all Microsoft organization mappings to companies.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations/companyMappings
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Map Microsoft Organization to Company
Maps a Microsoft organization to a company.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
vb365OrganizationUid
required
string <uuid> 
UID assigned to a Microsoft organization.


 
companyUid
required
string <uuid> 
UID assigned to a company.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/organizations/companyMappings
Request samples 
application/json
{
  • "vb365OrganizationUid": "04dd6f18-2c26-4f50-ae4f-cb9f463486a7",
  • "companyUid": "6e32e9d5-c1ad-4929-b9dd-a1bea4cbdcce"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Microsoft Organization to Company Mapping
Returns a resource representation of a Microsoft organization to company mapping with the specified UID.


Request 
path Parameters
mappingUid
required
string <uuid> 
Mapping UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations/companyMappings/{mappingUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Microsoft Organization to Company Mapping
Deletes a Microsoft organization to company mapping with the specified UID.


Request 
path Parameters
mappingUid
required
string <uuid> 
Mapping UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/vb365Servers/organizations/companyMappings/{mappingUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Veeam Backup for Microsoft 365 Server
Returns a resource representation of a connected Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Veeam Backup for Microsoft 365 Server
Disconnects Veeam Backup for Microsoft 365 server with the specified UID. 




The operation is available only for hosted Veeam Backup for Microsoft 365 servers. If you want to disconnect a client server, delete a management agent installed on that server.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/vb365Servers/{vb365ServerUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Enforce Data Collection from Veeam Backup for Microsoft 365 Server
Enforces data collection from a Veeam Backup for Microsoft 365 server with the specified UID.




Returns a positive response when the collection task is added to the internal queue and not when the task is executed.'




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/collect
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Microsoft Organizations Managed by Veeam Backup for Microsoft 365 Server
Returns a collection resource representation of all Microsoft organizations managed by Veeam Backup for Microsoft 365 server with the spectified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
expand
Array of strings (Vb365OrganizationBaseExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "OrganizationDetails" "Vb365Server"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Device Code
Generates a device code to log in to a Microsoft organization.




You can get a device code from Microsoft Azure to sign in to the Microsoft authentication portal.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
region
string
 Default:  "Default"
Region where a Microsoft organization is located.




Available only for Microsoft 365 and hybrid organizations.




 Enum: "Unknown" "Default" "Germany" "China" "USDefence" "USGovernment"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/deviceCode
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Device Code Status
Returns a resource representation of a device code status.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
code
required
string  [ 1 .. 30 ] characters 
Device code.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/deviceCode/{code}/status
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Microsoft Organization
Returns a resource representation of a Microsoft organization with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
expand
Array of strings (Vb365OrganizationBaseExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "OrganizationDetails" "Vb365Server"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Microsoft Organization
Deletes a Microsoft organization with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Microsoft 365 Organizations Managed by Veeam Backup for Microsoft 365 Server
Returns a collection resource representation of all Microsoft 365 organizations managed by a Veeam Backup for Microsoft 365 server with the spectified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
expand
Array of strings (Vb365Microsoft365OrganizationExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "OrganizationBase"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Microsoft 365 Organization
Creates a new Microsoft 365 organization on a Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
companyUid
string <uuid> 
UID assigned to a company to which a Microsoft 365 organization must be mapped.




For reseller users who create a Microsoft 365 organization, the parameter is required.




 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
required
object
Microsoft Exchange Online and Microsoft SharePoint Online connection settings for one of authentication types.


 
isTeamsOnline
boolean
 Default:  false
Indicates whether an organization contains Microsoft Teams components.




If the property has the true value, the exchangeAndSharePointOnlineConnectionSettings property becomes required.




 
isTeamsChatsOnline
boolean
 Default:  false
Indicates whether an organization contains Microsoft Teams chats.




Cannot be enabled if the isTeamsOnline property has the false value.




 
region
string (Vb365OrganizationRegion) 
 Default:  "Default"
Region where a Microsoft organization is located.




Available only for Microsoft 365 and hybrid organizations.




 Enum: "Unknown" "Default" "Germany" "China" "USDefence" "USGovernment"  
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365
Request samples 
application/json
{
  • "isTeamsOnline": true,
  • "isTeamsChatsOnline": false,
  • "exchangeAndSharePointOnlineConnectionSettings": {
    },
  • "region": "Default"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Microsoft 365 Organization
Returns a resource representation of a Microsoft 365 organization with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft 365 organization UID.


 
query Parameters
expand
Array of strings (Vb365Microsoft365OrganizationExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "OrganizationBase"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365/{vb365OrganizationUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Microsoft 365 Organization
Modifies a Microsoft 365 organization with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft 365 organization UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365/{vb365OrganizationUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Check Microsoft 365 Organization Application Certificate
Checks whether a security certificate is available for a Microsoft 365 organization application with the specified UID.




If a Microsoft 365 organization was not created in Veeam Service Provider Console, its application certificate is not available.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft 365 organization UID.


 
query Parameters
applicationUid
required
string <uuid> 
Microsoft 365 organization application UID.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
Returns the true value if the certificate is available and the false value if the certificate could not be found.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365/{vb365OrganizationUid}/certificate/exist
Request samples 
Response samples 
application/json
{
  • "data": false
}
Get All Microsoft Organization Groups
Returns a collection resource representation of all groups in a Microsoft organization with the specified UID.




The total property of the meta response section always has the 0 value.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
groupDisplayNameFilter
string or null  <= 256 characters 
Applies filtering by the `displayName' property.




Requires full match. You can use the * symbol before and after the search string.




 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/groups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Organization Sites
Returns a collection resource representation of all sites of a Microsoft organization with the specified UID.




The total property of the meta response section always has the 0 value.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
multiFilter
string or null  <= 256 characters 
Applies filtering by the title' or url` property.




Requires full match. You can use the * symbol before and after the search string.          




 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/sites
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Organization Teams
Returns a collection resource representation of all teams of a Microsoft organization with the specified UID.




The total property of the meta response section always has the 0 value.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
teamDisplayNameFilter
string or null  <= 256 characters 
Applies filtering by the `displayName' property.




Requires full match. You can use the * symbol before and after the search string.




 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/teams
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Organization Users
Returns a collection resource representation of all users of a Microsoft organization with the specified UID.




The total property of the meta response section always has the 0 value.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
userDisplayNameFilter
string or null  <= 256 characters 
Applies filtering by the `displayName' property.




Requires full match. You can use the * symbol before and after the search string.




 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/users
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Microsoft 365 Jobs
Returns a collection resource representation of all Veeam Backup for Microsoft 365 jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
siteFilter
Array of strings or null <uuid> 
Specifies the list of Veeam Cloud Connect site UIDs that limits the resources to the ones associated with those sites.


 
organizationFilter
string or null <uuid> 
Specifies the list of organization UIDs that limits the resources to the ones associated with those organizations.


 
locationFilter
string or null <uuid> 
Specifies the list of location UIDs that limits the resources to the ones associated with those locations.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations/jobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Delete Veeam Backup for Microsoft 365 Job
Deletes a Veeam Backup for Microsoft 365 job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365JobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Start Veeam Backup for Microsoft 365 Job
Starts a Veeam Backup for Microsoft 365 job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365JobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/start
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Stop Veeam Backup for Microsoft 365 Job
Stops a Veeam Backup for Microsoft 365 job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365JobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/stop
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Disable Veeam Backup for Microsoft 365 Job
Disables a Veeam Backup for Microsoft 365 job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365JobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/disable
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Enable Veeam Backup for Microsoft 365 Job
Enables a Veeam Backup for Microsoft 365 job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365JobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/enable
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Veeam Backup for Microsoft 365 Backup Copy Jobs
Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations/jobs/backup
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Veeam Backup for Microsoft 365 Backup Job
Creates a new Veeam Backup for Microsoft 365 backup job.




[For Veeam Backup for Microsoft 365 servers hosted by Veeam Service Provider Console] Company users must pass the null value for the schedulePolicy property. Otherwise the operation will result in error.  




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365OrganizationUid
required
string <uuid> 
Microsoft organization UID.


 
query Parameters
startJobAfterCreation
boolean
 Default:  false
Defines whether a backup job must automatically start after it is created.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
name
required
string
Name of a Veeam Backup for Microsoft 365 backup job.


 
repositoryUid
required
string <uuid> 
UID assigned to a backup repository.




When patching job target repository, you can use the GetVb365BackupJobAvailableBackupRepositories operation to retrieve a list of available repositories.




 
description
string or null
Description of a Veeam Backup for Microsoft 365 backup job.


 
isEnabled
boolean
 Default:  false
Indicates whether a Veeam Backup for Microsoft backup job is enabled.


 
backupType
string or null
Type of a Veeam Backup for Microsoft 365 backup job.


 Enum: "Unknown" "EntireOrganization" "SelectedItems"  
Array of objects (Vb365JobItemComposed) 
Array of backup job items.


 
Array of objects (Vb365JobItemComposed) 
Array of items excluded from the backup job.


 
object or null
Backup job schedule settings.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/jobs/backup
Request samples 
application/json
{
  • "name": "BackupJob2",
  • "description": "Veeam Backup for Microsoft 365 backup job",
  • "repositoryUid": "92421aa8-db1e-42ef-b210-b5d7750baffa",
  • "isEnabled": false,
  • "backupType": "SelectedItems",
  • "selectedItems": [
    ],
  • "excludedItems": [ ],
  • "schedulePolicy": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup for Microsoft 365 Backup Job
Returns a resource representation of a Veeam Backup for Microsoft 365 backup job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365BackupJobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 backup job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/backup/{vb365BackupJobUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Backup for Microsoft 365 Backup Job
Modifies a Veeam Backup for Microsoft 365 backup job with the specified UID.




[For Veeam Backup for Microsoft 365 servers hosted by Veeam Service Provider Console] Company users must not modify the schedulePolicy property. Otherwise the operation will result in error.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365BackupJobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 backup job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/backup/{vb365BackupJobUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Veeam Backup for Microsoft 365 Backup Copy Jobs
Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup copy jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/organizations/jobs/copy
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Veeam Backup for Microsoft 365 Backup Copy Job
Creates a new Veeam Backup for Microsoft 365 backup copy job.




You can save the job schedule only if that functionality is enabled for you in the Veeam Backup for Microsoft 365 resource configuration. Otherwise the operation will result in error.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
startJobAfterCreation
boolean
 Default:  false
Defines whether a job must automatically start after it is created.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
sourceBackupJobUid
required
string <uuid> 
UID assigned to a source Veeam Backup for Microsoft 365 job.


 
repositoryUid
required
string <uuid> 
UID assigned to a backup repository.


 
isEnabled
boolean
 Default:  true
Indicates whether a Veeam Backup for Microsoft 365 backup copy job is enabled.


 
object or null
Schedule settings of a Veeam Backup for Microsoft 365 backup copy job.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/copy
Request samples 
application/json
{
  • "sourceBackupJobUid": "666435cf-38fe-462d-9767-f610d5654d35",
  • "repositoryUid": "686085db-0a20-46b9-8cb6-3cbdf1a2a86f",
  • "schedulePolicy": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup for Microsoft 365 Backup Copy Job
Returns a resource representation of a Veeam Backup for Microsoft 365 backup copy job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365CopyJobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 backup copy job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/copy/{vb365CopyJobUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Backup for Microsoft 365 Backup Copy Job
Modifies a Veeam Backup for Microsoft 365 backup copy job with the specified UID.




You can save the job schedule only if that functionality is enabled for you in the Veeam Backup for Microsoft 365 resource configuration. Otherwise the operation will result in error.




Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365CopyJobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 backup copy job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/copy/{vb365CopyJobUid}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Backup Repositories Connected to Veeam Backup for Microsoft 365 Server
Returns a collection resource representation of all backup repositories connected to a Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/backupRepositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Available Backup Repositories for Veeam Backup for Microsoft 365 Backup Job
Returns a collection resource representation of backup repositories that can be selected as target repositories of a Veeam Backup for Microsoft 365 backup job with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
vb365BackupJobUid
required
string <uuid> 
Veeam Backup for Microsoft 365 backup job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/backup/{vb365BackupJobUid}/availableBackupRepositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup Proxies Connected to Veeam Backup for Microsoft 365 Server
Returns a collection resource representation of all backup proxies connected to a Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/backupProxies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup Proxy Pools Connected to Veeam Backup for Microsoft 365 Server
Returns a collection resource representation of all backup proxy pools connected to a Veeam Backup for Microsoft 365 server with the specified UID.


Request 
path Parameters
vb365ServerUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/vb365Servers/{vb365ServerUid}/backupProxyPools
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345