Perform selective deployment

Learn how to use the IS Deployments API to perform selective deployment of InsuranceSuite applications.

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

Parameter name	Description
tenantId	Your tenant ID.
projectId	ID of a star system (a physical project) that includes the InsuranceSuite applications that you deploy.
planetId	ID of a planet to which you deploy selected applications.
branchId	ID of a branch from which you deploy your builds.

Get a list of branches

To list all the branches for a star system, send the following GET request:

curl -X 'GET' \
  '{baseURL}/api/v1/tenants/{tenantId}/starsystems/{projectId}/planets/{planetId}/is/builds/branches' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Get a list of builds

To get a list of builds available for a particular branch, send the following GET request:

curl -X 'GET' \
 '{baseURL}/api/v1/tenants/{tenantId}/starsystems/{projectId}/planets/{planetId}/is/builds?branch=${branch}' \
 -H 'accept: application/json' \
 -H 'Authorization: Bearer {access_token}' \

A response contains a JSON object with a list of available builds.

Example response

[
    {
        "id": "cm/10/16",
        "application": "cm",

        ...
    },
    {
        "id": "cc/16/15",
        "application": "cc",

        ...
    },
    {
        "id": "pc/1/2",
        "application": "pc",

        ...
    }
]

Deploy selected applications with new builds

To specify new builds for an application, send the following POST request:

curl -X 'POST' \
 '{baseURL}/api/v1/tenants/{tenantId}/starsystems/{projectId}/planets/{planetId}/upgrade' \
 -H 'Content-Type:application/json' \
 -H 'Authorization: Bearer {access_token}' \
 -d '{body}'

Where {body} is an array of objects that represent InsuranceSuite applications to deploy. For example, to deploy ClaimCenter and PolicyCenter applications with new builds, use:

Request body

{
  "applications": [
    {
      "application": "cc",
      "buildId": "cc/16/15"
    },
    {
      "application": "pc",
      "buildId": "pc/8/8"
    }
  ]
}

Tip:

If you deploy an application without changing the build or any of the environment variables, the application is deployed again, but its nodes don't restart. To restart the application nodes, deploy an application with unchanged build value, and modify or add at least one environment variable.

Check the selective deployment status

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

curl -X 'GET' \
 '{baseURL}/api/v1/tenants/{tenantId}/starsystems/{projectId}/planets/{planetId}/status' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \

The selective deployment is completed when the value of phase is UPGRADED, and of phaseDetails is All applications upgraded.

Example response

{
  "phase": "UPGRADED",
  "environmentId": "test",
  "deploymentId": "0x0x0xx0-0000-0000-0000-00000x00xxx0",
  "activityName": "UpgradeJob",
  "operationInProgress": false,
  "phaseDetails": "All applications upgraded",
  "applications": [
    {
      ...
    }
  ]
}