#Use Public APIs

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

The following permissions are required to call this API.

#API Method

#Path Details

#[GET]/cloudbackup/jobs

Gets the job information of Cloud Backup for Microsoft 365.

#Query Parameters

#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:

Job summary:

Backup details:

Job errors:

#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
    }

    JobErrors: [

                {

                    IsErrorCode: boolean,

                    Value: string

                    Url: string

                    Number: 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.

#Example (application/json)

Response

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