Applications - Install Application Package

Trigger installation of an application package based on the package unique name into a target environment.

POST https://api.powerplatform.com/appmanagement/environments/{environmentId}/applicationPackages/{uniqueName}/install?api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
environmentId
path True

string

Environment ID (not to be confused with Org ID)

uniqueName
path True

string

Package unique name

api-version
query True

string

The API version

Request Body

Name Type Description
payloadValue

string

Responses

Name Type Description
200 OK

InstancePackage

Success

202 Accepted

Success

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com
Token URL: https://login.microsoftonline.com/common/oauth2/token

Definitions

Name Description
ApplicationVisibility

Application Visibility

ErrorDetails
InstancePackage
InstancePackageOperation
InstancePackageState

State of instance package

TpsInstallRequestPayload

Payload to be sent during installation of the package

ApplicationVisibility

Application Visibility

Name Type Description
All

string

BapAdminCenter

string

CrmAdminCenter

string

None

string

OneAdminCenter

string

ErrorDetails

Name Type Description
errorCode

integer

ErrorCode from CDS

errorName

string

Error Name

message

string

Error message

source

string

Source of the error

statusCode

integer

Status code for error

type

string

Error Type

InstancePackage

Name Type Description
applicationDescription

string

Application description associated with the instance package

applicationId

string

Application ID associated with the instance package

applicationName

string

Application name associated with the instance package

applicationVisibility

ApplicationVisibility

Application Visibility

customHandleUpgrade

boolean

Custom handle upgrade flag for the application

id

string

InstancePackage ID

lastOperation

InstancePackageOperation

learnMoreUrl

string

Learn more url for the application

localizedDescription

string

Localized description of application

localizedName

string

Localized name of application

packageId

string

Package ID

packageUniqueName

string

Package Unique Name

packageVersion

string

Package Version

publisherId

string

Publisher ID

publisherName

string

Publisher name for the application

singlePageApplicationUrl

string

Single Page Application URL

termsOfServiceBlobUris

string[]

TOS for the application

InstancePackageOperation

Name Type Description
createdOn

string

DateTime for creation of the instance package operation

errorDetails

ErrorDetails

instancePackageId

string

InstancePackage ID

modifiedOn

string

DateTime for modification of the instance package operation

operationId

string

Operation ID for the operation triggered on the instance package

state

InstancePackageState

State of instance package

statusMessage

string

Status Message

InstancePackageState

State of instance package

Name Type Description
InstallFailed

string

InstallRequested

string

InstallRetrying

string

InstallScheduled

string

Installed

string

Installing

string

None

string

TemplateInstalled

string

UninstallFailed

string

UninstallRequested

string

Uninstalled

string

Uninstalling

string

TpsInstallRequestPayload

Payload to be sent during installation of the package

Name Type Description
payloadValue

string