#Use Public APIs

*Note: We are upgrading to a new API for better user experience, stability, and easier integration. **for more details.

Cloud Backup for Microsoft 365 provides the /cloudbackup/jobs and /cloudbackup/licenseconsumption API endpoints. These interfaces empower users to seamlessly retrieve job-related information and monitor subscription consumption through standardized HTTP GET requests. By leveraging these APIs, users gain comprehensive insights and granular access to job reports and subscription consumption metrics, thereby enhancing the ability to manage, analyze, and optimize backup operations with precision and efficiency.

#Permission

*Note: We are upgrading to a new API for better user experience, stability, and easier integration. **for more details.

The following permissions are required to call this API.

*Note: You must register an app through AvePoint Online Services > App registration to authenticate and authorize your access to AvePoint Graph API. For details, refer to .

API	Permission required
/cloudbackup/jobs	microsoft365backup.jobInfo.read.all
/cloudbackup/licenseconsumption	microsoft365backup.subscriptionInfo.read.all

#API Method

*Note: We are upgrading to a new API for better user experience, stability, and easier integration. **for more details.

Method	Path	Description
GET	/cloudbackup/jobs	Gets the job information of Cloud Backup for Microsoft 365.
GET	/cloudbackup/licenseconsumption	Gets the subscription consumption information of Cloud Backup for Microsoft 365.

#Path Details

*Note: We are upgrading to a new API for better user experience, stability, and easier integration. **for more details.

#[GET]/cloudbackup/jobs

Gets the job information of Cloud Backup for Microsoft 365.

#Query Parameters

Parameter	Description	Type
StartTime	Sets a start time (UTC time) for the time range.	long
FinishTime	Sets an end time (UTC time) for the time range.	long
JobType	Sets the job types that you want to get.Defined by #/components/schemas/BackupJobType.	EnumValid values: 0 (for All)1 (for Backup)2 (for Restore)3 (for Export)4 (for Delete)5 (for Retention)
ObjectType	Sets the service type of the jobs to get.Defined by #/components/schemas/CloudBackupJobObjectType.	EnumValid values: 0 (for All) 1 (for Exchange Online) 2 (for SharePoint Online) 3 (for OneDrive)4 (for Microsoft 365 Groups)5 (for Project Online)6 (for Public Folder)7 (Teams) 8 (Viva Engage)9 (Teams Chat)10 (Power BI) 11 (Power Automate) 12 (Power Apps)
JobState	Sets the job status.Defined by #/components/schemas/CloudBackupJobState	EnumValid values:0 (for All)1 (for In Progress)2 (for Finished)3 (for Failed)4 (for Finished with Exception)5 (for Partially Finished)
PageIndex	Sets the starting number of the page to get the jobs. The default value is 0.	int
PageSize	Sets the number of jobs to display on one page. The default value is 10.	int

#Responses

If the request has been successfully processed, a 200 OK response will be returned, along with the requested information displayed in the response body.

Retrieved result:

Response	Description	Type
TotalCount	The total count of the retrieved jobs	int
Jobs	A list of jobs	List
NextLink	Reference to the next page of results	string

Job summary:

Response	Description	Type
Id	Job ID	string
State	Job status	string
StartTime	Job started time	long
FinishTime	Job finished time	long
Duration	Duration	long
BackupDetails	Job details	int

Backup details:

Response	Description	Type
TotalCount	Total count	long
FailedCount	Number of failed objects	long
SuccessfulCount	Number of successful objects	long
SkippedCount	Number of skipped objects	long

Job errors:

IsErrorCode	Whether this error has an error code associated	boolean
Value	Error message	string
Url	Error code URL	string
Number	Occurrences of the error in this job	long

#Example (application/json):

Request

{ StartTime?: long FinishTime?: long. JobType?: #/components/schemas/BackupJobType ObjectType?: #/components/schemas/CloudBackupJobObjectType JobState?: #/components/schemas/CloudBackupJobState PageIndex?: int PageSize?: int }

Response

{ TotalCount?: int Jobs:[ {
Id?: string State?: string StartTime?: long FinishTime?: long Duration?: long BackupDetails?: { TotalCount?: long FailedCount?: long SuccessfulCount?: long SkippedCount?: long }

}

]

}

#[GET]/cloudbackup/licenseconsumption

Gets the subscription consumption information of Cloud Backup for Microsoft 365.

#Responses

If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body.

Response	Description	Type
OutOfPolicyTime	The UTC that the license got out of policy.	long
PurchasedUserSeats	Purchased user seats	int
AssignedUserSeats	Assigned user seats	int
PurchasedStorageSize	Purchased storage size	int
ProtectedSize	Protected size	int

#Example (application/json)

Response

{ OutOfPolicyTime?: long PurchasedUserSeats?: int AssignedUserSeats?: int PurchasedStorageSize?: int ProtectedSize?: int }