Management

Plan a Lifecycle Operation

Changed on

Plans the install or upgrade the installed state calls for, or an uninstallation when operation is uninstall. Stores it as the pending plan and returns it for review, together with its issues as a validation result. Start it with POST /installation and its id as planId.

post/installation/plan

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /installation/plan
  • Auth: OAuth 2 (client credentials, token URL https://ims-na1.adobelogin.com/ims/token/v3, scopes: AdobeID, openid)

Headers

x-gw-ims-org-idstring required

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

Request body

ioEventsUrlstring required
ioEventsEnvstring required
operation'uninstall'

Set to uninstall to plan an uninstallation. Without it, POST /installation/plan plans the install or upgrade the installed state calls for.

planIdstring

The id of the pending plan to start. Required by POST /installation.

Response

The plan and its validation result.

validboolean required

Changes

  • 759439d755adRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 670d2ef21b7dRevision changes
    • info

      endpoint added