#Supported APIs

The API URL of Elements is https://graph.avepointonlineservices.com/partner.

#GET api/v1.1/customers

Get the general information of the customers that you manage.

Required Permission: partner.customers.read.all

Response Information:

Element	Description	Type
id	The tenant owner ID of the customer.	string
organization	The organization name of the customer.	string
ownerEmail	The tenant owner email address of the customer.	string
jobStatus	The status of the customer’s tenant.	string
countryOrRegion	The country or region name of the customer.	string

#GET api/v1.1/customers('id')

Get the general information of a specific customer that you manage.

Required Permission: partner.customers.read.all

Response Information:

Element	Description	Type
id	The tenant owner ID of the customer.	string
organization	The organization name of the customer.	string
ownerEmail	The tenant owner email address of the customer.	string
jobStatus	The status of the customer’s tenant.	string
countryOrRegion	The country or region name of the customer.	string

#GET api/v1.1/customers('id')/protected

Get your customers’ protected data information of Cloud Backup for Microsoft 365.

*Note: Only the Cloud Backup for Microsoft 365 service that customers have the subscription for is supported.

Required Permission: partner.cbprotected.read.all

Response Information:

Element	Description	Type
customerId	The tenant owner ID of the customer.	string
customer	The tenant owner email address of the customer.	string
serviceType	The Cloud Backup for Microsoft 365 service that the customer has subscriptions for.	string
serviceModule	The module of the customer’s service.	string
totalScannedObjects	The number of the scanned objects.	integer
totalProtectedObjects	The number of the backed-up objects.	integer
dataSizeStoredInAvePoint	The size of the backed-up objects stored in the AvePoint storage.	string
dataSizeStoredInBYOS	The size of the backed-up objects stored in BYOS.	string

#GET api/v1.1/services

Get the license details of different services for the customers that you manage.

*Note: Only services that customers have the Enterprise subscription for are supported.

Required Permission: partner.license.read.all

Response Information:

Element	Description	Type
customerId	The tenant owner ID of the customer.	string
organization	The organization name of the customer.	string
customer	The tenant owner email address of the customer.	string
tenantId	The tenant ID of the customer.	string
products	A list of products that the customer has subscribed.	list

Product subscriptions:

Element	Description	Type
service	The service that the customer has subscriptions for.	string
subscriptionModel	The subscription model of the customer’s service.	string
purchasedUserSeats	The number of purchased user seats of the customer.	string
purchasedUnits	The number of purchased Microsoft 365 tenants of the customer.	string
microsoftLicenseAssigned	The number of assigned Microsoft licenses of the customer.	string
microsoftLicenseAvailable	The number of available Microsoft licenses of the customer.	string
purchasedCapacity	The purchased capacity of the customer.	string
protectedCapacity	The protected data size of the customer.	string
storage	The storage type of the customer.	string
retention	The data retention period of the customer.	string
consumedStorage	The consumed storage size of the customer.	string
expirationDate	The expiration date of the customer’s service.	string
change	The user seats change in the pooled license compared with the first day of the current month.	string
source	The source of the subscription.	string
paymentType	The payment type of the subscription.	string
subscriptionName	The subscription name. This parameter is intended specifically for the Fly service.	string
package	The package of the subscription. This parameter is intended specifically for the Cloud Backup for Microsoft 365 service.	string
contractEndDate	The contract end date of the subscription.	string

#GET api/v1.1/services('CustomerId')

Get the license details of different services for a specific customer that you manage.

*Note: Only services that customers have the Enterprise subscription for are supported.

Required Permission: partner.license.read.all

Response Information:

Element	Description	Type
customerId	The tenant owner ID of the customer.	string
organization	The organization name of the customer.	string
customer	The tenant owner email address of the customer.	string
tenantId	The tenant ID of the customer.	string
products	A list of products that the customer has subscribed.	list

Product subscriptions:

Element	Description	Type
service	The service that the customer has subscriptions for.	string
subscriptionModel	The subscription model of the customer’s service.	string
purchasedUserSeats	The number of purchased user seats of the customer.	string
purchasedUnits	The number of purchased Microsoft 365 tenants of the customer.	string
microsoftLicenseAssigned	The number of assigned Microsoft licenses of the customer.	string
microsoftLicenseAvailable	The number of available Microsoft licenses of the customer.	string
purchasedCapacity	The purchased capacity of the customer.	string
protectedCapacity	The protected data size of the customer.	string
storage	The storage type of the customer.	string
retention	The data retention period of the customer.	string
consumedStorage	The consumed storage size of the customer.	string
expirationDate	The expiration date of the customer’s service.	string
change	The user seats change in the pooled license compared with the first day of the current month.	string
source	The source of the subscription.	string
paymentType	The payment type of the subscription.	string
subscriptionName	The subscription name. This parameter is intended specifically for the Fly service.	string
package	The package of the subscription. This parameter is intended specifically for the Cloud Backup for Microsoft 365 service.	string
contractEndDate	The contract end date of the subscription.	string

#GET api/v1.1/customers('id')/jobs

Get the job details of the backup services of a specific customer that you manage.

*Note: Only job details of the service that the customer has the subscription for are supported.

Required Permission: partner.jobs.read.all

Response Information:

Element	Description	Type
jobType	The service type of the job.	string
jobModule	The service module of the job.	string
status	The job status.	string
jobId	The job ID.	string
name	The job name.	string
totalCount	The count of the objects that have been processed by the job.	string
failedCount	The count of the failed objects.	string
successfulCount	The count of the successful objects.	string
skippedCount	The count of the skipped objects.	string
warningCount	The count of the warning objects.	string
backupSize	The size of the backed-up objects.	string
startTime	The start time of the job	string
endTime	The end time of the job.	string
jobDuration	The job duration.	string
lastModifyTime	The last modified time of the job.	string

#GET api/v1.1/customers('id')/jobs(JobType='job type',JobModule='job module')

Get the job details of a specific job type and module of backup service for a customer that you manage.

*Note: Only job details of the service that the customer has the subscription for are supported.

Supported job type values: Microsoft 365, Google Workspace, IaaS PaaS, Dynamics 365, or Salesforce

Supported job module values:

Required Permission: partner.jobs.read.all

Response Information:

Element	Description	Type
jobType	The service type of the job.	string
jobModule	The service module of the job.	string
status	The job status.	string
jobId	The job ID.	string
name	The job name.	string
totalCount	The count of the objects that have been processed by the job.	string
failedCount	The count of the failed objects.	string
successfulCount	The count of the successful objects.	string
skippedCount	The count of the skipped objects.	string
warningCount	The count of the warning objects.	string
backupSize	The size of the backed-up objects.	string
startTime	The start time of the job	string
endTime	The end time of the job.	string
jobDuration	The job duration.	string
lastModifyTime	The last modified time of the job.	string

#GET api/v1.1/customers('id')/scanprofiles

Get the information of all scan profiles configured in AvePoint Online Services for a customer.

Required Permission: partner.scanprofiles.read.all

Response Information:

Element	Description	Type
profileName	The name of the scan profile.	string
profileId	The ID of the scan profile.	string
scanMode	The scan mode of the scan profile.0 – Express mode1 – Advance mode	integer
modifiedTime	The last modified time of the scan profile.	string

#GET api/v1.1/customers('id')/ScanProfilesDetails(ProfileId='ProfileId')

Get a scan profile information configured in AvePoint Online Services for a customer.

Required Permission: partner.scanprofiles.read.all

Response Information:

Element	Description	Description	Type
profileId	The ID of the scan profile.	The ID of the scan profile.	string
profileName	The name of the scan profile.	The name of the scan profile.	string
description	The description of the scan profile.	The description of the scan profile.	string
tenantId	The tenant ID the scan profile.	The tenant ID the scan profile.	string
tenantDomain	The tenant domain of the scan profile.	The tenant domain of the scan profile.	string
scanMode	The scan mode of the scan profile.0 – Express mode1 – Advance mode	The scan mode of the scan profile.0 – Express mode1 – Advance mode	integer
modifiedTime	The last modified time of the scan profile.	The last modified time of the scan profile.	string
createdTime	The created time of the scan profile.	The created time of the scan profile.	string
impersonationAccount	The impersonation account configured in the scan profile.	The impersonation account configured in the scan profile.	string
scanInplaceArchivedMailboxes	Whether or not the Scan in-place archived mailboxes setting is enabled in the scan profile.True – EnabledFalse – Disabled	Whether or not the Scan in-place archived mailboxes setting is enabled in the scan profile.True – EnabledFalse – Disabled	boolean
isIgnoreLockedSiteEnabled	Whether or not the Ignore the locked objects when updating the job status setting is enabled in the scan profile.True – EnabledFalse – Disabled	Whether or not the Ignore the locked objects when updating the job status setting is enabled in the scan profile.True – EnabledFalse – Disabled	boolean
enableDailyScan	Whether or not the Enable daily scan setting is enabled in the scan profile.No – Disabledhh:mm – The time of the daily scan. For example: 01:59.	Whether or not the Enable daily scan setting is enabled in the scan profile.No – Disabledhh:mm – The time of the daily scan. For example: 01:59.	string
isSendOutOfPolicyNotification	Whether or not the Send an email notification to the following recipients when objects are moved to other containers or removed from any containers setting is enabled in the scan profile.True – EnabledFalse – Disabled	Whether or not the Send an email notification to the following recipients when objects are moved to other containers or removed from any containers setting is enabled in the scan profile.True – EnabledFalse – Disabled	boolean
containers	The container details of the scan profile.	ContainersName	string
containers	The container details of the scan profile.	ObjectType	string

#GET api/v1.1/Customers('id')/ScanProfilesDailyNew(ProfileId='ProfileId')

Get the daily scan profile changes in AvePoint Online Services for a customer.

Required Permission: partner.scanprofiles.read.all

Response Information:

Element	Description	Type
profileName	The name of the scan profile.	string
profileID	The ID of the scan profile.	string
tenantDomain	The tenant domain of the scan profile.	string
tenantID	The tenant ID the scan profile.	string
description	The description of the scan profile.	string
scanMode	The scan mode of the scan profile.0 – Express mode1 – Advance mode	integer
modifiedTime	The last modified time of the scan profile.	string
lastUpdateTime	The time of generating the daily report for the scan profile. If no daily report has been generated, the time is the last modified time of the scan profile.	string
lastScanStatus	The last scan job status of the scan profile.1 – In progress2 – Finished3 – Failed4 – Finished with exception5 – Skipped10 – Stopped	integer
newRegisteredContentCount	The number of newly registered contents in the daily report of the scan profile.	integer
movedToAnotherContainer	The number of objects moved to another container in the daily report of the scan profile.	integer
removedFromMicrosoft365OrOutofPolicy	The number of objects removed from Microsoft 365 or out of policy in the daily report of the scan profile.	integer

*Note: To improve the experience, we’ve added newRegisteredContentCount to replace newRegistedContentCount.

#GET api/v1.1/Customers('id')/ScanProfilesDailyNewDetail(ProfileId='ProfileId')

Get the daily scan profile change details in AvePoint Online Services for a customer.

Required Permission: partner.scanprofiles.read.all

Response Information:

Element	Description	Description	Type
profileName	The name of the scan profile.	The name of the scan profile.	string
profileID	The ID of the scan profile.	The ID of the scan profile.	string
tenantDomain	The tenant domain of the scan profile.	The tenant domain of the scan profile.	string
tenantID	The tenant ID the scan profile.	The tenant ID the scan profile.	string
lastUpdateTime	The time of generating the daily report for the scan profile. If no daily report has been generated, the time is the last modified time of the scan profile.	The time of generating the daily report for the scan profile. If no daily report has been generated, the time is the last modified time of the scan profile.	string
newRegisteredContent	The details of newly registered contents in the daily report of the scan profile.	objectName	string
newRegisteredContent	The details of newly registered contents in the daily report of the scan profile.	containerName	string
removedFromMicrosoft365OrOutOfPolicyObjects	The details of objects moved to another container in the daily report of the scan profile.	objectName	string
removedFromMicrosoft365OrOutOfPolicyObjects	The details of objects moved to another container in the daily report of the scan profile.	containerName	string
movedToAnotherContainerObjects	The details of objects removed from Microsoft 365 or out of policy in the daily report of the scan profile.	objectName	string
movedToAnotherContainerObjects	The details of objects removed from Microsoft 365 or out of policy in the daily report of the scan profile.	containerName	string

*Note: To improve the experience, we’ve added newRegisteredContent to replace newRegistedContent.