Veeam Service Provider Console 9
REST API Reference
Related documents
Search

Breaking Changes

The following list contains changes that cause previous versions of Veeam Service Provider Console REST API to function differently:

  • For REST API v3.5 and v3.5.1, in the CompanyServices schema, the maximum value of the storageQuota property is now 2305843008139952128.
  • For REST API v3.5 and v3.5.1, in the CompanyHostedVbrBackupResource, CompanyVb365BackupResource and CompanyVb365BackupResourceInput schemas, the storageQuota property now represents the storage space quota in gigabytes instead of bytes. The minimum value is now 1 and the maximum value is now 104856551424.
  • For REST API v3.5 and v3.5.1, in the CompanySiteTrafficResource schema, the dataTransferOutQuota property now represents the data transfer out traffic quota in gigabytes instead of bytes. Note that to modify this property value using the PatchCompanySiteTrafficResource operation, you must still provide a new value in bytes.
  • The minimum value of the storageQuota property of the ResellerSiteBackupResource and ResellerSiteBackupResourceInput schemas is now 1073741824.
  • Job schedulling can no longer be disabled for Veeam Backup & Replication and Veeam Backup for Microsoft 365 servers. The isJobSchedulingEnabled property was removed from the CompanyHostedVbrResource and CompanyVb365Resource schemas. In previous versions, changes applied to the value of this property will be applied to a company that owns the server. Note that the isJobSchedulingEnabled property of the Vb365OrganizationBase schema defines whether the current user can apply changes.
  • Removed the following deprecated operations:
  • AsymmetricAlgorithmChallenge
  • AsymmetricAlgorithmCompleteChallenge
  • UsernamePasswordAuthenticate
  • RefreshTokenAuthenticate
  • The hardwarePlanUid property of the ResellerSiteReplicationResource schema is now read-only.
  • The DeleteCompany operation now unassigns all assigned tenants and deletes a company. The removeBackups parameter was removed from the operation. In older REST API versions, the operation deletes both a company and all assigned tenants.
  • Removed the GetCompaniesSiteResources operation. To get data on company site resources, use the GetTenants operation. In older REST API versions, the GetCompaniesSiteResources operation returns all tenants assigned to companies.
  • Removed the GetCompanySiteResource operation. To get company site resource data, use the GetTenant operation. In older REST API versions, the GetCompanySiteResource operation returns a random tenant assigned to a company.
  • Removed the CreateCompanySiteResource operation. To allocate a cloud resource to a company, create a tenant using the CreateTenant operation. In older REST API versions, the CreateCompanySiteResource operation creates a cloud resource on a site. If a company already has site resources assigned, the NotAllowedOperation error with the 1000 code is returned.
  • The GetCompanySiteResources operation now returns the collection of resources with CloudTenant schema instead of the CompanySiteResource schema.
  • Removed the DeleteCompanySiteResource operation. To remove company cloud resource, delete a tenant assigned to a company using the DeleteTenant operation. The deleteBackups parameter of the DeleteTenant operation allows you to delete or retain cloud backups similar to the removeBackups parameter of the DeleteCompanySiteResource operation. In older REST API versions, the DeleteCompanySiteResource operation deletes a cloud resource on a site. If a company has more than one site resource assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the PatchCompanySiteResource operation with the PatchTenant operation. In older REST API version, the PatchCompanySiteResource operation modifies a cloud resource on a site. If a company has more than one site resource assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompaniesSiteBackupResources operation with the GetTenantsBackupResources operation. In older REST API versions, the GetCompaniesSiteBackupResources operation returns backup resources of all company tenants.
  • Replaced the GetCompanySiteBackupResources operation with the GetTenantBackupResources operation. In older REST API versions, the GetCompanySiteBackupResources operation returns backup resources of all tenants assigned to a company.
  • Replaced the CreateCompanySiteBackupResource operation with the CreateTenantBackupResource operation. In older REST API versions, the CreateCompanySiteBackupResource operation creates a site backup resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompanySiteBackupResourcesUsage operation with the GetTenantBackupResourcesUsage operation. In older REST API versions, the GetCompanySiteBackupResourcesUsage operation returns data on usage of site backup resources for a company tenant registered as first in the database on a site.
  • Replaced the GetCompaniesSiteBackupResourcesUsages operation with the GetTenantsSiteBackupResourcesUsages operation. In older REST API versions, the GetCompaniesSiteBackupResourcesUsages operation returns data on usage of site backup resources for all tenants assigned to companies.
  • Replaced the GetCompanySiteBackupResource operation with the GetTenantBackupResource operation. In older REST API versions, the GetCompanySiteBackupResource operation returns a site backup resource of a company tenant registered as first in the database on a site.
  • Replaced the PatchCompanySiteBackupResource operation with the PatchTenantBackupResource operation. In older REST API versions, the PatchCompanySiteBackupResource operation modifies a site backup resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the DeleteCompanySiteBackupResource operation with the DeleteTenantBackupResource operation. In older REST API versions, the DeleteCompanySiteBackupResource operation deletes a site backup resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompanySiteTrafficResource operation with the GetTenantTrafficResource operation. In older REST API versions, the GetCompanySiteTrafficResource operation returns a cloud traffic quota configured for a company tenant registered as first in the database on a site.
  • Replaced the PatchCompanySiteTrafficResource operation with the PatchTenantTrafficResource operation. In older REST API versions, the PatchCompanySiteTrafficResource operation modifies a cloud traffic quota configured for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompaniesSiteReplicationResources operation with the GetTenantsReplicationResources operation. In older REST API versions, the GetCompaniesSiteReplicationResources operation returns replication resources of all company tenants.
  • Replaced the GetCompanySiteReplicationResources operation with the GetTenantReplicationResources operation. In older REST API versions, the GetCompanySiteReplicationResources operation returns replication resources of all tenants assigned to a company.
  • Replaced the CreateCompanySiteReplicationResource operation with the CreateTenantReplicationResource operation. In older REST API versions, the CreateCompanySiteReplicationResource operation creates a site replication resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the PatchCompanySiteReplicationResource operation with the PatchTenantReplicationResource operation. In older REST API versions, the PatchCompanySiteReplicationResource operation modifies a site replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompanySiteReplicationResourceHardwarePlan operation with the GetTenantReplicationResourceHardwarePlan operation. In older REST API versions, the GetCompanySiteReplicationResourceHardwarePlan operation returns a hardware plan of a company tenant registered as first in the database on a site.
  • Removed the DeleteCompanySiteReplicationResourceHardwarePlan operation. To unassign a hardware plan from a company tenant, use the PatchTenantReplicationResource operation. In older REST API versions, the DeleteCompanySiteReplicationResourceHardwarePlan operation deletes a site replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompanySiteReplicationResourcesNetworkAppliances operation with the GetTenantReplicationResourcesNetworkAppliances operation. In older REST API versions, the GetCompanySiteReplicationResourcesNetworkAppliances operation returns all network extension appliances configured for a company tenant registered as first in the database on a site.
  • Replaced the GetCompanySiteReplicationResourcesNetworkAppliance operation with the GetTenantReplicationResourcesNetworkAppliance operation. In older REST API versions, the GetCompanySiteReplicationResourcesNetworkAppliance operation returns a network extension appliance configured for a company tenant registered as first in the database on a site.
  • Replaced the PatchCompanySiteReplicationResourcesNetworkAppliance operation with the PatchTenantReplicationResourcesNetworkAppliance operation. In older REST API versions, the PatchCompanySiteReplicationResourcesNetworkAppliance operation modifies a network extension appliance of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompaniesSiteReplicationResourcesUsages operation by the GetTenantsReplicationResourcesUsages operation. In older REST API versions, the GetCompaniesSiteReplicationResourcesUsages operation returns data on usage of site replication resources for all tenants assigned to companies.
  • Replaced the GetCompanySiteReplicationResourcesUsage operation with the GetTenantReplicationResourcesUsage operation. In older REST API versions, the GetCompanySiteReplicationResourcesUsage operation returns data on usage of site replication resources for a company tenant registered as first in the database on a site.
  • Replaced the GetCompaniesSiteVcdReplicationResources operation with the GetTenantsVcdReplicationResources operation. In older REST API versions, the GetCompaniesSiteVcdReplicationResources operation returns VMware Cloud Director replication resources of all company tenants.
  • Replaced the GetCompanySiteVcdReplicationResources operation with the GetTenantVcdReplicationResources operation. In older REST API versions, the GetCompanySiteVcdReplicationResources operation returns VMware Cloud Director replication resources of all company tenants.
  • Replaced the CreateCompanySiteVcdReplicationResource operation with the CreateTenantVcdReplicationResource operation. In older REST API versions, the CreateCompanySiteVcdReplicationResource operation creates a VMware Cloud Director replication resource for a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the PatchCompanySiteVcdReplicationResource operation with the PatchTenantVcdReplicationResource operation. In older REST API versions, the PatchCompanySiteVcdReplicationResource operation modifies a VMware Cloud Director replication resource of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompanySiteVcdReplicationResourceDataCenter operation with the GetTenantVcdReplicationResourceDataCenter operation. In older REST API versions, the GetCompanySiteVcdReplicationResourceDataCenter operation returns an organization VDC of a company tenant registered as first in the database on a site.
  • Removed the DeleteCompanySiteVcdReplicationResourceDataCenter operation. Use the operation PatchTenantVcdReplicationResource to unassign an organization VDC from a company tenant. In older REST API versions, the DeleteCompanySiteVcdReplicationResourceDataCenter operation unassigns an organization VDC from a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.
  • Replaced the GetCompaniesSiteVcdReplicationResourcesUsages operation with the GetTenantsVcdReplicationResourcesUsages operation. In older REST API versions, the GetCompaniesSiteVcdReplicationResourcesUsages operation returns data on usage of VMware Cloud Director replication resources for all tenants assigned to companies.
  • Replaced the GetCompanySiteVcdReplicationResourcesUsage operation with the GetTenantVcdReplicationResourcesUsage operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesUsage operation returns data on usage of VMware Cloud Director replication resources for a company tenant registered as first in the database on a site.
  • Replaced the GetCompanySiteVcdReplicationResourcesNetworkAppliances operation with the GetTenantVcdReplicationResourcesNetworkAppliances operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesNetworkAppliances operation returns all VMware Cloud Director network extension appliances configured for a company tenant registered as first in the database on a site.
  • Replaced the GetCompanySiteVcdReplicationResourcesNetworkAppliance operation with the GetTenantVcdReplicationResourcesNetworkAppliance operation. In older REST API versions, the GetCompanySiteVcdReplicationResourcesNetworkAppliance operation returns a VMware Cloud Director network extension appliance configured for a company tenant registered as first in the database on a site.
  • Replaced the PatchCompanySiteVcdReplicationResourcesNetworkAppliance operation with the new PatchTenantVcdReplicationResourcesNetworkAppliance operation. In older REST API versions, the PatchCompanySiteVcdReplicationResourcesNetworkAppliance operation modifies a VMware Cloud Director network extension appliance of a company tenant. If a company has more than one tenant assigned, the NotAllowedOperation error with the 1000 code is returned.

Page updated 8/29/2025

Page content applies to build 9.0.0.29555

View all results across Veeam Help Center
Back to document search