Home > EnPower Web API (Legacy)

Export to PDF

EnPower Web API (Legacy)

EnPower provides Web APIs to retrieve Power Platform data from EnPower that can be integrated with other inventories and used for report generation.

For more details on the available APIs and data retrieval details, refer to the following sections.

NOTE

From February 9, 2025, AvePoint Graph API is available for retrieving data from EnPower. Apart from Power Platform object details, Graph API supports a wider range of data retrieval. The legacy API introduced below for Power Platform data retrieval still functions while is scheduled for deprecation. Transitioning to AvePoint Graph APIs is highly recommended to ensure continued support and access to the latest features. For detailed steps on leveraging the API methods, refer to AvePoint Graph API.

Register an AvePoint App

Before using the APIs, you must register an app in AvePoint Online Services > Administration > App registrations and grant permission to the app. With the registered app, you can use the generated application (client) ID for authentication.

To register the app, complete the following steps:

  1. On the App registrations page, click Create.

  2. In the Create app registration panel, enter the app name and configure the following:

    • Assigned services and permissions – Assign the required permission to the app. For data retrieval using the EnPower Web API, make sure the app has the “enpower.data.read.all” permission.

    • Certificates and secrets – Click the Client secret tab and click Add client secret. After selecting the effective duration and adding the secret. You can click the Copy icon to save a copy of the secret.

  3. Click Save. The client ID will be available after the app is registered.

For more details on app registration and management in AvePoint Online Services, refer to Configure App Registrations.

Get the Access Token

Once you have the application (client) ID, you can retrieve the access token via the application (client) ID and client secret to authenticate with the EnPower Web API.

To get the access token with a client secret added during app registration, follow the steps below:

  1. Set the access token URL (API endpoint) based on your organization’s AvePoint environment:

    • AOS commercial environment: https://identity.avepointonlineservices.com/connect/token

    • U.S. Government environment: https://identity-gov.avepointonlineservices.com/connect/token

  2. Set the header to Content-Type: application/x-www-form-urlencoded.

  3. Set the following parameters in the request body:

    • client_id – The Application (Client) ID of the app you registered in AvePoint Online Services.

    • client_secret – Copy the Client secret you added during the app registration.

    • scope – Set this value to enpower.data.read.all.

    • grant_type – Set this value to client_credentials.

Example Request

POST https://identity.avepointonlineservices.com/connect/token Content-Type: application/x-www-form-urlencoded client_id={your_app_client_id}&client_secret={your_app_client_secret}&scope=enpower.data.read.all&grant_type=client_credentials

Example Response

A successful request returns a JSON response containing the access token as the following:

{ "access_token":"eyJhbGciOiJSUzI1NiIsIm……", "expires_in":3600, "token_type":"Bearer", "scope":"enpower.data.read.all" }
NOTE
  • The access_token node is the token value and it is a Bearer token that should be included in the Authorization header of subsequent API requests.
  • The expires_in node denotes the number of seconds until the received token expires. After the expiration, a new token can be retrieved using the same process.

Call EnPower Web API

After the access token is retrieved, it can then be used for EnPower Web API calling. Refer to the sections below for the detailed instructions.

Data Center and Web API URLs

To check the data center of your tenant, sign in to AvePoint Online Services. Click your profile photo in the upper-right corner and click Organization profile. In the Organization profile panel, you can find the data center that your organization belongs to.

Data centerWeb API URL
Australia Southeast (Victoria)https://graph-au.avepointonlineservices.com/smp
Canada Central (Toronto)https://graph-ca.avepointonlineservices.com/smp
Germany West Central (Frankfurt)https://graph-de.avepointonlineservices.com/smp
East US (Virginia)https://graph-us.avepointonlineservices.com/smp
France Central (Paris)https://graph-fr.avepointonlineservices.com/smp
Japan West (Osaka)https://graph-jp.avepointonlineservices.com/smp
Korea Central (Seoul)https://graph-kr.avepointonlineservices.com/smp
North Europe (Ireland)https://graph-ne.avepointonlineservices.com/smp
Southeast Asia (Singapore)https://graph-sg.avepointonlineservices.com/smp
Switzerland North (Zurich)https://graph-ch.avepointonlineservices.com/smp
UK South (London)https://graph-uk.avepointonlineservices.com/smp
US Gov Virginia (Virginia)https://graph-gov.avepointonlineservices.com/smp
West Europe (Netherlands)https://graph-we.avepointonlineservices.com/smp

Power Platform API EndPoints

Refer to the table below for the available EnPower Web API EndPoints. The {base_url} should be replaced with the Web API data center URL related to your organization.

API EndPointsDescription
GET {base_url}/api/v1/powerplatform/powerappsRetrieve Power App related data in EnPower, including data displayed in the EnPower > Power Platform > Power Apps > Apps tab.
GET {base_url}/api/v1/powerplatform/powerautomateRetrieve Power Automate cloud flow related data in EnPower, including data displayed in the EnPower > Power Platform > Power Automate > Cloud flows tabs.
GET {base_url}/api/v1/powerplatform/connectionsRetrieve connections related data in EnPower, including data displayed in the EnPower > Power Platform > Connections page.
GET {base_url}/api/v1/powerplatform/environmentsRetrieve environment related data in EnPower, including data displayed in the EnPower > Power Platform > Environments page.
GET {base_url}/api/v1/powerplatform/powerbi/workspacesRetrieve Power BI workspace related data in EnPower, including data displayed in the EnPower > Power Platform > Power BI > Workspaces tab.
GET {base_url}/api/v1/powerplatform/powerbi/artifactsRetrieve Power BI artifact related data in EnPower, including data displayed in the EnPower > Power Platform > Power BI > Artifacts tab.

Request Payload

Header: Authorization: Bearer {access_token}

Example Request

GET https://graph-us.avepointonlineservices.com/smp/api/v1/powerplatform/powerapps Authorization: Bearer {access_token}

Example Response

A successful request returns a JSON response as the following:

{ "Results": [ { "Id": "c7208b44-f730-ed11-9db0-000d3a541f7c_cf25f394-6434-4285-8b77-12628cee6a9f_default-cf25f394-6434-4285-8b77-12628cee6a9f", "AppId": "c7208b44-f730-ed11-9db0-000d3a541f7c", "Container": "Common.Container.Default.PowerApp", "TenantDomain": "xxx", "ContainerId": "a4a21ec1-caf3-4321-b5c8-dd1c578fdf5a", "TenantId": "cf25f394-6434-4285-8b77-12628cee6a9f", "Environment": "Default-cf25f394-6434-4285-8b77-12628cee6a9f" … } ], "Status": 200, "Message": "", "Content": null, "NextLink": "https://graph-us.avepointonlineservices.com/smp/api/v1/powerplatform/powerapps?Page=4lg3msyxnY%2BOgf2v0dFIdr67T7HjKX9A1SS94dhrhYFKDKGZLzK1vFMqXlvroGGCoBFIxTcvxPwF77wioqf9i54k1Qkgiox3gBjUnDgl9HLUbTeGTM%2F6MVWh1WvUrBQ5%2Fx6gy%2FTTLwzeCcCrSOTq3w%3D%3D" }
NOTE
  • By default, the number of results returned on one page is 100, which is also the maximum number per page. However, you can customize the number by using the top filter. For example: https://graph-us.avepointonlineservices.com/smp/api/v1/powerplatform/powerapps?top=10
  • If the query returns more than 100 results, the response will include a next link with which you can retrieve the next set of results. For example: https://graph-us.avepointonlineservices.com/smp/api/v1/powerplatform/powerapps?Page=4lg3msyxnY%2BOgf2v0dFIdr67T7HjKX9A1SS94dhrhYFKDKGZLzK1vFMqXlvroGGCoBFIxTcvxPwF77wioqf9i54k1Qkgiox3gBjUnDgl9HLUbTeGTM%2F6MVWh1WvUrBQ5%2Fx6gy%2FTTLwzeCcCrSOTq3w%3D%3D
  • To query the information from a specific tenant, you can also use the tenant filter. For example: https://graph-us.avepointonlineservices.com/smp/api/v1/powerplatform/powerapps?tenant=cf25f394-6434-4285-8b77-12628cee6a9f
  • The throttling threshold is 15,000 requests. When you see a 429 error code in the response, please retry later. For example: HttpStatusCode 429 Status429TooManyRequests