Undeploy applications

Learn how to use the EnterpriseEngage Deployments API to undeploy all or selected EnterpriseEngage applications.

All the sample requests in this guide include the following path parameters:

Parameter name	Description
tenantId	Your tenant ID.
starsystem	ID of a star system that includes the EnterpriseEngage applications that you undeploy.
planetId	ID of a planet to which you deploy applications.

Get a list of EnterpriseEngage application instances

To list all the EnterpriseEngage application instances deployed on a planet, send the following GET request:

curl -X 'GET' \
  '{baseURL}/api/v2/tenants/{tenant}/starsystems/{starsystem}/planets/{planet}/appInstances' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

A response contains a JSON object with a list of EnterpriseEngage application instances deployed on your planet.

Example response

[
  {
    "id": "producer-engage",
    "name": "Producer Engage",
    ...
  },
  {
    "id": "quote-and-buy",
    "name": "Quote & Buy",
    ...
  }
]

Undeploy applications

To undeploy all or selected applications, send the following POST request:

curl -X 'POST' \
  '{baseURL}/api/v2/tenants/{tenant}/starsystems/{starsystem}/planets/{planet}/activities/undeployments \
  -H 'Content-Type:application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{body}'

Where {body} is an array of objects that represent EnterpriseEngage applications to undeploy. For example, to undeploy CustomerEngage Quote and Buy and CustomerEngage Account Management, use:

Request body

{
  "appInstances": ["quote-and-buy", "account-management"]
}

A response contains a JSON object with an activity ID.

Example response

{
  "uuid": "000xx00-x0xx-0x00-0x0x-xx000x0x0x0xxx"
}

Check the undeployment status

To check if the undeployment is completed, send the following GET request:

curl -X 'GET' \
 '{baseURL}/api/v2/tenants/{tenant}/starsystems/{starsystem}/planets/{planet}/activities/{uuid}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \

As {uuid}, enter the activity ID that you received in a response to the POST undeployment request.

A response contains a JSON object with the activity details. The undeployment is completed when the value of status is SUCCESSFUL.

Example response

{
  "uuid": "000xx00-x0xx-0x00-0x0x-xx000x0x0x0xxx",
  "activityType": "DEPLOYMENT",
  "status": "SUCCESSFUL",
  "startedOn": "2019-08-24T14:15:22Z",
  "completedOn": "2019-08-24T14:15:22Z",
  "triggeredBy": "string",
  "tenant": "string",
  "starsystem": "string",
  "planet": "string",
  "duration": 0,
  "timeout": 600,
  "source": "REST",
  "tasks": [
    {
    ...
    }
  ]
}