Sign in
Management

Reconcile Installation (Install or Upgrade)

Desired-state endpoint. Reconciles the app toward the target configuration: when no installation baseline exists it installs the app, except for post-app-deploy invocations, which return 409 not-installed; when a baseline exists it upgrades from the baseline to the version declared in metadata.version. An upgrade must keep the installed metadata.id; a different application ID is rejected before planning. The chosen branch is reported in the response operation field.

post/installation

Headers

x-gw-ims-org-idstring required

Adobe IMS organization ID that identifies the organization for the request.

x-aio-commerce-installation-invocation-source'post-app-deploy'

Identifies the source of the request. The generated post-deploy hook sends post-app-deploy; when that source is present and the app is not installed, reconciliation returns 409 not-installed instead of starting a first-time installation.

Request body

commerceBaseUrlstring

Commerce instance base URL. Required for a first-time installation; for an upgrade it is optional and derived from the existing Commerce association.

commerceEnv'paas' | 'saas'

Commerce deployment flavor. Required for a first-time installation; for an upgrade it is optional and derived from the existing Commerce association.

ioEventsUrlstring required
ioEventsEnvstring required

Response

Manual-mode upgrade: the upgrade plan was created or reused and returned without starting execution (metadata.upgradeMode is manual).

messagestring required
operation'upgrade' required
planobject required

The planned upgrade, spanning every participating domain.

Changes