AvePoint Learn
Request article
Contact support
Request article
Contact support
English

Home > Fly Public API

Export to PDF

Fly Public API

Fly provides public APIs to perform Exchange Online / Microsoft 365 Groups / Microsoft Teams / Microsoft Teams Chat / OneDrive / SharePoint Online migrations. Refer to the instructions below to use the public APIs.

Register an AvePoint App

Before using the APIs, you must register an app in AvePoint Online Services and grant permissions to the app. With the registered app, you can use the generated application (client) ID for authentication. Refer to the following URLs to access the page where you can register the app.

  • Commercial – Click here to register an app.

  • U.S. Government – Click here to register an app.

Refer to the AOS User Guide for detailed instructions on how to register an app.

The following information about the app will be used by scripts to connect to Fly:

ElementDescription
Application (Client) IDThe application (client) ID you have retrieved.
CertificateThe corresponding .pfx certificate file of the .cer certificate you used while registering the AvePoint app. Note that the certificate must be installed on the machine where you run PowerShell. Make sure the Mark this key as exportable. This will allow you to back up or transport your keys at a later time option is selected while installing the certificate.

Use PowerShell SDK

Fly provides a Software Development Kit (SDK) for integration with PowerShell. Refer to the steps below to use the public APIs:

  1. Use the following commands to install and import the Fly PowerShell module:

    Install-Module -Name Fly.Client

    Import-Module -Name "Fly.Client"

    NOTE

    The Fly PowerShell module requires PowerShell 5.1 or later.

  2. Refer to the example below to connect to Fly.

    Example.

    When using the Fly public API, you will need the public API URL. The public API URL varies with your data center. Choose the public API URL according to your data center.

    Data CenterWeb API URL
    Australia Southeast (Victoria)https://graph-au.avepointonlineservices.com/fly
    Canada Central (Toronto)https://graph-ca.avepointonlineservices.com/fly
    Germany West Central (Frankfurt)https://graph-de.avepointonlineservices.com/fly
    East US (Virginia)https://graph-us.avepointonlineservices.com/fly
    France Central (Paris)https://graph-fr.avepointonlineservices.com/fly
    Japan West (Osaka)https://graph-jp.avepointonlineservices.com/fly
    Korea Central (Seoul)https://graph-kr.avepointonlineservices.com/fly
    North Europe (Ireland)https://graph-ne.avepointonlineservices.com/fly
    Southeast Asia (Singapore)https://graph-sg.avepointonlineservices.com/fly
    Switzerland North (Zurich)https://graph-ch.avepointonlineservices.com/fly
    United Arab Emirates (Dubai)https://graph-uae.avepointonlineservices.com/fly
    UK South (London)https://graph-uk.avepointonlineservices.com/fly
    US Gov Virginia (Virginia)https://graph-gov.avepointonlineservices.com/fly
    West Europe (Netherlands)https://graph-we.avepointonlineservices.com/fly
    Qatar Central (Doha)https://graph-qa.avepointonlineservices.com/fly
    South Africa North (Johannesburg)https://graph-za.avepointonlineservices.com/fly

  3. Perform Exchange Online / Microsoft 365 Groups / Microsoft Teams / Microsoft Teams Chat / OneDrive / SharePoint Online migrations.

    Click here to find more information on what is possible with Fly public API.