Microsoft Power Platform API reference (preview)

Artigo
11/07/2022

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

Power Platform API is a RESTful web API that enables you to access Power Platform services and resources.

To use the Power Platform API:

Register your app.
Get authentication tokens for a user or service.

Important

This is a preview feature.
Preview features aren’t meant for production use and may have restricted functionality. These features are available before an official release so that customers can get early access and provide feedback.
This feature is being gradually rolled out across regions and might not be available yet in your region.

Call a REST API method

To read from or write to a resource such as a user or an email message, you construct a request that looks like the following:

{HTTP method} https://api.powerplatform.com/{namespace}/{resource}?api-version={version}

The components of a request include:

{HTTP method} - The HTTP method used on the request to Power Platform API.
{namespace} - The logical grouping of capabilities you're referencing.
{resource} - The resource in Power Platform API that you're referencing.
{version} - The version of the Power Platform API you're using.

HTTP methods

Power Platform API uses the HTTP method on your request to determine what your request is doing. The API supports the following methods.

Method	Description
GET	Read data from a resource.
POST	Create a new resource, or perform an action.
PATCH	Update a resource with new values.
PUT	Replace a resource with a new one.
DELETE	Remove a resource.

For the CRUD methods GET and DELETE, no request body is required.
The POST, PATCH, and PUT methods require a request body, usually specified in JSON format, that contains additional information, such as the values for properties of the resource.

Namespace

The Power Platform API defines most of its resources, methods, and enumerations in namespaces. Each namespace is a logical grouping of capabilities such as Licensing for Billing Policy administration, and AppManagement for managing installation for Microsoft-provided application packages in Dataverse. More namespaces will be added over time, until full parity is reached in Power Platform API for what an administrator can perform in Power Platform admin center. From that point onward, new features will always be made available API-first.

Resource

A resource can either be tenant level or environment level:

When a resource is at the tenant level, the tenantID is inferred using the OAuth bearer token and the call is routed to the Azure region that matches your tenant's physical address. An example tenant level resource call would be:

GET https://api.powerplatform.com/licensing/billingPolicies/{billingPolicyId}?api-version=2022-03-01-preview

When a resource is at the environment level, the tenantID is still inferred as mentioned above but an environmentID must also be specified in the path before you can interact with the resource. An example environment level resource call would be:

GET https://api.powerplatform.com/appmanagement/environments/{environmentId}/operations/{operationId}?api-version=2022-03-01-preview

For details about permissions, go to Permissions reference.

Version

Power Platform API is currently in public preview and hence only single version is available.

For more information about API versions, see Versioning and support.

Tutorials for using Power Platform API

You might be wondering how do I make use of these REST endpoints in an end to end, real world scenario? We're so glad you asked! Use the following tutorials:

Next steps

You're ready to get up and running with Power Platform API. Go to Getting started with Power Platform API.

Partilhar via