Skip to content

Commit 2072f05

Browse files
alice-shi-avepointalice-shi-avepoint
authored
Merge pull request #8 from AvePoint/april-release
April release
2 parents 5c16ade + 1315898 commit 2072f05

59 files changed

Lines changed: 765 additions & 263 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/docfx.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"_disableContribution": true,
3434
"pdf": true,
3535
"pdfTocPage": true,
36-
"pdfFileName": "AvePoint Graph Modern API Documentation.pdf"
36+
"pdfFileName": "AvePoint Graph API Documentation.pdf"
3737
}
3838
}
3939
}

‎docs/docs/Overview.md‎

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
# Overview
22

3-
The AvePoint Graph Modern API is a robust suite of tools designed to streamline integration and enhance functionality for managing your digital collaboration environment. This API allows developers to interact programmatically with AvePoint's solutions, facilitating automation, data integration, and enhanced operational capabilities.
3+
The AvePoint Graph API is a robust suite of tools designed to streamline integration and enhance functionality for managing your digital collaboration environment. It allows developers to interact programmatically with AvePoint's solutions, facilitating automation, data integration, and enhanced operational capabilities.
44

5-
## Available APIs
6-
7-
AvePoint Confidence Platform offers a range of APIs to suit different integration needs. The modern API provides advanced features and security, while the legacy API, though still functional, is scheduled for deprecation. Below is a detailed overview of each option:
8-
9-
### Modern API
10-
11-
The Modern API provides advanced features to optimize integration and security:
5+
The API provides advanced features to optimize integration and security:
126

137
- Authentication methods: Supports client secret and certificate authentication for secure and efficient access control. This flexibility allows developers to choose the most suitable authentication method for their needs.
148
- Unified endpoint: The API can be accessed via a unified endpoint format `https://graph-{dc}.avepointonlineservices.com`. Note that the endpoint differs based upon the data center you want to access. For details, refer to [Endpoints Upon Data Centers](#endpoints-upon-data-center).
@@ -18,33 +12,31 @@ The Modern API provides advanced features to optimize integration and security:
1812
- Comprehensive functionality: Enables seamless interaction with AvePoint services, supporting tasks like data management, reporting, and configuration.
1913
- Scalability and performance: Designed to handle large-scale operations, ensuring reliability and speed in various enterprise scenarios.
2014

21-
### Legacy API
15+
## Legacy API
2216

2317
The legacy API offers essential capabilities but is slated for deprecation:
2418

2519
- Functionalities:
26-
2720
- Retrieve audit records for compliance and monitoring.
2821
- Import objects into AvePoint Online Services for streamlined data management.
2922
- Register partner customers to facilitate partner integrations.
3023
- Access Cloud Backup for Microsoft 365 job information for backup management.
3124

32-
- **Deprecation Notice**: This API is scheduled for deprecation after the December 2024 release. Transitioning to modern APIs is highly recommended to ensure continued support and access to the latest features.
25+
- **Deprecation Notice**: This API has been deprecated after the December 2024 release. Transitioning to the current API is highly recommended to ensure continued support and access to the latest features.
3326
- Documentation: For additional details on the legacy API, refer to [AvePoint Online Services Web API Help](https://avepointcdn.azureedge.net/assets/webhelp/avepoint-online-services-api/index.htm).
34-
By leveraging these APIs, you can efficiently manage and interact with your cloud data in the AvePoint Confidence Platform, ensuring seamless integration and enhanced productivity.
3527

36-
## What's in AvePoint Graph Modern API
28+
## What's in the current AvePoint Graph API
3729

38-
AvePoint Graph Modern API provides a unified endpoint to accessing AvePoint services data, designed to cater to IT professionals seeking robust data management, data insights, and backup monitoring solutions.
30+
AvePoint Graph API provides a unified endpoint to accessing AvePoint services data, designed to cater to IT professionals seeking robust data management, data insights, and backup monitoring solutions.
3931

4032
### Introduction
4133

42-
This API employs advanced authentication methods to ensure secure and efficient access to a wide range of functionalities. These include:
34+
The AvePoint Graph API employs advanced authentication methods to ensure secure and efficient access to a wide range of functionalities. These include:
4335

4436
- Retrieve audit records: Access comprehensive records from AvePoint Online Services.
4537
- Streamline partner operations on customer management: Enhance efficiency in handling customer data and interactions through the Elements platform.
4638
- Job information retrieval: Obtain detailed job data from AvePoint's Cloud Backup solutions for Microsoft 365, Microsoft Azure, AWS, Dynamics 365, and Google Workspace.
47-
- EnPower data retrieval: Access and manage Power Platform data including environments, connections, Power Apps, Power Automate Cloud Flows, and Power BI artifacts.
39+
- EnPower data retrieval: Access and manage Exchange mailboxes and Power Platform data.
4840
- Insights data retrieval: Access detailed reports and data insights from Insights for Microsoft 365.
4941
- AvePoint Opus data management: Submit records to AvePoint Opus, retrieve due records, and destroy records.
5042

@@ -58,7 +50,7 @@ This API employs advanced authentication methods to ensure secure and efficient
5850

5951
- Job Information Retrieval: Detailed insights into Cloud Backup operations to ensure data integrity and availability.
6052

61-
- EnPower Data Retrieval: Manage and retrieve data for Power Platform environments, connections, Power Apps, Power Automate Cloud Flows, and Power BI artifacts.
53+
- EnPower Data Retrieval: Manage and retrieve data for Exchange mailboxes and Power Platform environments, connections, Power Apps, Power Automate Cloud Flows, and Power BI artifacts.
6254

6355
- Insights Data Retrieval: Export and retrieve detailed reports and data insights for Microsoft 365.
6456

@@ -69,18 +61,41 @@ For more features and use cases, visit the [Use Cases](Use-Cases.md).
6961

7062
### Endpoints Upon Data Center
7163

72-
| Region | URL |
73-
|------------------------------|---------------------------------|
74-
| APAC - Australia | `https://graph-au.avepointonlineservices.com/`|
75-
| APAC - Singapore | `https://graph-sg.avepointonlineservices.com/`|
76-
| Canada Central (Toronto) | `https://graph-ca.avepointonlineservices.com/`|
77-
| EMEA - Ireland | `https://graph-ne.avepointonlineservices.com/` |
78-
| EMEA - Netherlands | `https://graph-we.avepointonlineservices.com/` |
79-
| France Central (Paris) | `https://graph-fr.avepointonlineservices.com/` |
80-
| Germany West Central (Frankfurt) | `https://graph-de.avepointonlineservices.com/` |
81-
| Japan West - Osaka | `https://graph-jp.avepointonlineservices.com/` |
82-
| Korea Central (Seoul) | `https://graph-kr.avepointonlineservices.com/` |
83-
| Switzerland North (Zurich) | `https://graph-ch.avepointonlineservices.com/` |
84-
| UK South (London) | `https://graph-uk.avepointonlineservices.com/` |
85-
| US - East | `https://graph-us.avepointonlineservices.com/`|
86-
| AOS-US Gov |`https://graph-gov.avepointonlineservices.com/`|
64+
>[!NOTE]
65+
>Effective April 2025 release, AvePoint Online Services commercial production environment now supports the following **Google Cloud Platform (GCP) data centers**:
66+
> - GCP for Australia Southeast (Sydney)
67+
> - GCP for Japan (Tokyo)
68+
> - GCP for East US (Moncks Corner)
69+
> - GCP for West Europe (Eemshaven, Netherlands)
70+
>
71+
> These GCP data centers are currently deployed with the following AvePoint services:
72+
> - AvePoint Online Services
73+
> - Cloud Backup for Microsoft 365
74+
> - Cloud Backup for Google Workspace
75+
> - AvePoint Opus
76+
> - Insights
77+
>
78+
> In addition to the core deployments, the **public APIs** for these products now fully support **GCP data center endpoints**.
79+
80+
Refer to the data center endpoints in the table below:
81+
82+
|Infrastructure | Region | URL |
83+
|---|------------------------------|---------------------------------|
84+
|Microsoft Azure | APAC - Australia | `https://graph-au.avepointonlineservices.com/`|
85+
|| APAC - Singapore | `https://graph-sg.avepointonlineservices.com/`|
86+
|| Canada Central (Toronto) | `https://graph-ca.avepointonlineservices.com/`|
87+
|| EMEA - Ireland | `https://graph-ne.avepointonlineservices.com/` |
88+
|| EMEA - Netherlands | `https://graph-we.avepointonlineservices.com/` |
89+
|| France Central (Paris) | `https://graph-fr.avepointonlineservices.com/` |
90+
|| Germany West Central (Frankfurt) | `https://graph-de.avepointonlineservices.com/` |
91+
|| Japan West - Osaka | `https://graph-jp.avepointonlineservices.com/` |
92+
|| Korea Central (Seoul) | `https://graph-kr.avepointonlineservices.com/` |
93+
|| Switzerland North (Zurich) | `https://graph-ch.avepointonlineservices.com/` |
94+
||UK South (London) | `https://graph-uk.avepointonlineservices.com/` |
95+
|| US - East | `https://graph-us.avepointonlineservices.com/`|
96+
|| AOS-US Gov |`https://graph-gov.avepointonlineservices.com/`|
97+
|Google Cloud Platform| Australia Southeast (Sydney): **australia-southeast1**|`https://graph-gcp-au.avepointonlineservices.com/`|
98+
||Japan (Tokyo): **asia-northeast1**|`https://graph-gcp-jp.avepointonlineservices.com/`|
99+
||East US (Moncks Corner): **us-east1**|`https://graph-gcp-us.avepointonlineservices.com/`|
100+
||West Europe (Eemshaven, Netherlands): **europe-west4**|`https://graph-gcp-we.avepointonlineservices.com/`|
101+

docs/docs/Use-AvePoint-Graph-Modern-API.md renamed to docs/docs/Use-AvePoint-Graph-API.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Use AvePoint Graph Modern API <!-- omit in toc -->
1+
# Use AvePoint Graph API <!-- omit in toc -->
22

33
**In this article**
44

@@ -14,11 +14,11 @@
1414

1515
<!-- /TOC -->
1616

17-
Welcome to the AvePoint Graph Modern API, your gateway to accessing and managing the AvePoint Confidence Platform with efficiency and security. This API is designed to streamline your data management and backup monitoring processes, providing IT professionals with robust tools and insights.
17+
Welcome to the AvePoint Graph API, your gateway to accessing and managing the AvePoint Confidence Platform with efficiency and security. This API is designed to streamline your data management and backup monitoring processes, providing IT professionals with robust tools and insights.
1818

1919
## Authentication and Authorization
2020

21-
To access the resources of AvePoint Cloud Services via the AvePoint Graph Modern API, you must configure the app registration and grant the necessary permissions. This process involves:
21+
To access the resources of AvePoint Cloud Services via the AvePoint Graph API, you must configure the app registration and grant the necessary permissions. This process involves:
2222

2323
- **Registering an app**: Set up your app in AvePoint Online Services.
2424
- **Permissions**: Assign the appropriate permissions for your app.
@@ -53,7 +53,7 @@ After making a request, a response is returned that includes:
5353

5454
## HTTP Methods
5555

56-
The Modern API uses the HTTP methods to specify the action being performed on a request. Currently, the API documented here only supports:
56+
The API uses the HTTP methods to specify the action being performed on a request. Currently, the API documented here only supports:
5757

5858
| Method | Description |
5959
|------|------|
@@ -76,4 +76,4 @@ HTTP status codes indicate the outcome of a request. Common codes include:
7676

7777
## Resource
7878

79-
A resource can be an entity or complex type, commonly defined with properties. Your URL will include the resource you are interacting with in the request, such as `customers`, `services`, and `jobs`. Methods can also be used to perform operations on these resources.
79+
A resource can be an entity or complex type, commonly defined with properties. Your URL will include the resource you are interacting with in the request, such as `customers`, `services`, and `jobs`. Methods can also be used to perform operations on these resources.

‎docs/docs/Use-Cases.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Use Cases
22

3-
By integrating the AvePoint Graph Modern API into their operations, organizations can achieve enhanced control, security, and efficiency in managing their data and IT services.
3+
By integrating the AvePoint Graph API into their operations, organizations can achieve enhanced control, security, and efficiency in managing their data and IT services.
44

55
## Secure Data Access and Management
66

@@ -39,4 +39,4 @@ AvePoint Opus API methods allows organizations to efficiently manage their conte
3939

4040
- **Fly**: Execute migrations with Fly to seamlessly migrate data between systems. [See more](https://cdn.avepoint.com/assets/webhelp/fly/index.htm#!Documents/flypublicapi.htm)
4141

42-
- **Cloud Governance**: Manage data within Cloud Governance to streamline governance processes and data handling. [See more](https://cdn.avepoint.com/assets/webhelp/avepoint-cloud-governance-administrator-guide/index.htm#!Documents/avepointcloudgovernancemodernapi.htm)
42+
- **Cloud Governance**: Manage data within Cloud Governance to streamline governance processes and data handling. [See more](https://cdn.avepoint.com/assets/webhelp/avepoint-cloud-governance-administrator-guide/index.htm#!Documents/avepointcloudgovernanceapi.htm)

‎docs/docs/change-log.md‎

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,49 @@
11
# Change Log
22

3-
This document provides a detailed log of changes, updates, and enhancements made to the AvePoint Graph Modern API. It includes information on newly introduced features, improvements to existing functionalities, and any fixes applied. Stay up-to-date with the latest modifications to ensure optimal integration and utilization of the API.
3+
This document provides a detailed log of changes, updates, and enhancements made to the AvePoint Graph API. It includes information on newly introduced features, improvements to existing functionalities, and any fixes applied. Stay up-to-date with the latest modifications to ensure optimal integration and utilization of the API.
4+
5+
## April 2025
6+
7+
### Added
8+
9+
- The public APIs for **AvePoint Online Services**, **Cloud Backup for Microsoft 365**, **Cloud Backup for Google Workspace**, **Insights**, and **AvePoint Opus**, now fully support **GCP data center endpoints**.
10+
- Introduced new endpoints to EnPower for retrieving Exchange objects:
11+
- `/smp/exchange/resourcemailboxes`
12+
- `/smp/exchange/mailboxes`
13+
- Added the `jobType` property to the response of the `backup/vm/jobs` endpoint.
14+
15+
16+
17+
### Changed
18+
- **Cloud Backup for Microsoft 365**
19+
- Updated the `/backup/m365/cloudbackup/getjobs` endpoint to `/backup/m365/jobs`.
20+
- Updated the `/backup/m365/cloudbackup/licenseconsumption` endpoint to `/backup/m365/licenseconsumption`.
21+
- Updated the `/backup/m365/cloudbackup/unusualactivitydata` endpoint to `/backup/m365/unusualactivitydata`.
22+
- **Elements**
23+
- Updated the `/partner/customers/{id}/scanProfilesDetails/profileId/{ProfileId}` endpoint to `/partner/customers/{id}/scanProfiles/{ProfileId}`.
24+
- Updated the `/partner/customers/{id}/scanProfilesDailyNew/profileId/{ProfileId}` endpoint to `/partner/customers/{id}/scanProfiles/{ProfileId}/dailyNewSummary`.
25+
- Updated the `/partner/customers/{id}/scanProfilesDailyNewDetail/profileId/{ProfileId}` endpoint to `/partner/customers/{id}/scanProfiles/{ProfileId}/dailyNewDetails`.
26+
- **EnPower**
27+
- Removed the `ownerCount` and `userCount` properties from the response of the `/smp/powerplatform/powerapps` endpoint.
28+
29+
30+
### Fixed
31+
32+
- Corrected the spelling mistake of the `conflictOption` property in the request of the `/records/connector/records` endpoint. It was previously misspelled as `confilictOption`.
33+
- Corrected the following property types in the `/smp/powerplatform/environments` endpoint response:
34+
- Corrected the type of `phaseAssignees` to "Object".
35+
- Corrected the type of `dlpPolicies` to "Integer".
36+
- Documented the `location` query parameter for the `/backup/m365/jobs` and `backup/m365/licenseconsumption` endpoints.
437

538
## February 2025
639

740
### Added
841

9-
- Introduced new endpoints to AvePoint Graph Modern API for:
42+
- Introduced new endpoints to AvePoint Graph API for:
1043
- Cloud Backup for Google Workspace
1144
- AvePoint Opus
1245
- Insights for Microsoft 365
13-
- EnPower
46+
- EnPower
1447
- Implemented new API for retrieving unusual activities or potential ransomware attacks for Microsoft 365 environment in the `/backup/m365/cloudbackup/unusualactivitydata` endpoint.
1548

1649
### Changed
@@ -28,13 +61,12 @@ This document provides a detailed log of changes, updates, and enhancements made
2861
### Fixed
2962
- Resolved the issue with the `Dynamics.ReadWrite.All` scope where the API does not work when using it with the other scopes. -->
3063

31-
3264
## December 2024
3365

3466
### Added
3567

36-
- Initial release of the AvePoint Graph Modern API.
37-
- Introduced endpoints for retrieving audit records, managing partner operations, and accessing job information from AvePoint Cloud Backup solutions.
68+
- Initial release of the AvePoint Graph API.
69+
- Introduced endpoints for retrieving audit records, managing partner operations, and accessing job information and subscription consumption from AvePoint Cloud Backup solutions.
3870

3971
### Deprecated
40-
- Marked the legacy API for deprecation after the December 2024 release. Transition to the modern API is recommended.
72+
- Marked the legacy API for deprecation after the December 2024 release. Transition to the current API is recommended.

0 commit comments

Comments
 (0)