List environments (preview)

2025-03-11

Note

The new and improved Power Platform admin center is now generally available. We're currently updating the documentation to reflect these changes, so check back to ensure that you're getting the latest updates.

[This article is pre-release documentation and is subject to change.]

You can list environments for your tenant.

Authentication

For more information about permissions and how to select them, see Authentication - legacy.

HTTP request

Authorization: Bearer eyJ0eXAiOi...
Host: api.bap.microsoft.com
Accept: application/json
GET https://api.bap.microsoft.com/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments?api-version=2020-10-01&$expand=properties.capacity,properties.addons

Request headers

Header	Value
Authorization	Bearer {token} (required)
Content-Type	application/json

Request body

Don't supply a request body for this method.

Response

The response is always a 200 OK response, unless you aren't correctly authenticated.

Example

{
  "value": [
    {
      "id": "/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "type": "Microsoft.BusinessAppPlatform/scopes/environments",
      "___location": "unitedstates",
      "name": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
      "properties": {
        "azureRegion": "westus",
        "displayName": "My Power Platform Environment",
        "description": "This is my environment purpose description",
        "createdTime": "2020-10-22T04:38:17.8550157Z",
        "createdBy": {
          "id": "0f747967-84c4-4f29-84c2-682fb00390c8",
          "displayName": "ServicePrincipal",
          "type": "ServicePrincipal",
          "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee"
        },
        "lastModifiedTime": "2021-02-22T18:38:08.4718532Z",
        "provisioningState": "Succeeded",
        "creationType": "User",
        "environmentSku": "Sandbox",
        "isDefault": false,
        "capacity": [
          {
            "capacityType": "Database",
            "actualConsumption": 1392.68,
            "ratedConsumption": 1392.68,
            "capacityUnit": "MB",
            "updatedOn": "2021-02-23T04:41:01Z"
          },
          {
            "capacityType": "File",
            "actualConsumption": 1567.697,
            "ratedConsumption": 1567.697,
            "capacityUnit": "MB",
            "updatedOn": "2021-02-23T04:41:01Z"
          },
          {
            "capacityType": "Log",
            "actualConsumption": 0,
            "ratedConsumption": 0,
            "capacityUnit": "MB",
            "updatedOn": "2021-02-23T04:41:01Z"
          }
        ],
        "addons": [
          {
            "addonType": "AppPass",
            "allocated": 1,
            "addonUnit": "Unit"
          },
          {
            "addonType": "PerFlowPlan",
            "allocated": 0,
            "addonUnit": "Unit"
          },
          {
            "addonType": "PortalViews",
            "allocated": 0,
            "addonUnit": "Unit"
          },
          {
            "addonType": "PortalLogins",
            "allocated": 0,
            "addonUnit": "Unit"
          },
          {
            "addonType": "AI",
            "allocated": 0,
            "addonUnit": "Unit"
          },
          {
            "addonType": "AppPassForTeams",
            "allocated": 0,
            "addonUnit": "Unit"
          },
          {
            "addonType": "PAUnattendedRPA",
            "allocated": 0,
            "addonUnit": "Unit"
          }
        ],
        "clientUris": {
          "admin": "https://admin.powerplatform.microsoft.com/environments/5ca1c616-6060-46ba-abc1-18d312f1cb3a/hub",
          "maker": "https://make.powerapps.com/environments/5ca1c616-6060-46ba-abc1-18d312f1cb3a/home"
        },
        "runtimeEndpoints": {
          "microsoft.BusinessAppPlatform": "https://unitedstates.api.bap.microsoft.com",
          "microsoft.CommonDataModel": "https://unitedstates.api.cds.microsoft.com",
          "microsoft.PowerApps": "https://unitedstates.api.powerapps.com",
          "microsoft.Flow": "https://unitedstates.api.flow.microsoft.com",
          "microsoft.PowerAppsAdvisor": "https://unitedstates.api.advisor.powerapps.com",
          "microsoft.ApiManagement": "https://management.usa.azure-apihub.net"
        },
        "databaseType": "CommonDataService",
        "linkedEnvironmentMetadata": {
          "resourceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
          "friendlyName": "My Power Platform Environment",
          "uniqueName": "96c28a9e98934bf798bb71c9d92134",
          "domainName": "org0fadb1dd",
          "version": "9.2.21013.00152",
          "instanceUrl": "https://org0fadb1dd.crm.dynamics.com/",
          "instanceApiUrl": "https://org0fadb1dd.api.crm.dynamics.com",
          "baseLanguage": 1033,
          "instanceState": "Ready",
          "createdTime": "2020-10-22T04:38:24.003Z",
          "backgroundOperationsState": "Enabled",
          "scaleGroup": "NAMCRMLIVESG644",
          "platformSku": "Standard"
        },
        "notificationMetadata": {
          "state": "NotSpecified",
          "branding": "NotSpecific"
        },
        "retentionPeriod": "P7D",
        "states": {
          "management": {
            "id": "Ready"
          },
          "runtime": {
            "id": "Enabled"
          }
        },
        "updateCadence": {
          "id": "Frequent"
        },
        "retentionDetails": {
          "retentionPeriod": "P7D",
          "backupsAvailableFromDateTime": "2021-02-16T05:42:52.2822636Z"
        },
        "protectionStatus": {
          "keyManagedBy": "Microsoft"
        },
        "cluster": {
          "number": "108"
        },
        "connectedGroups": []
      }
    }
  ]
}

Share via