Deploy all applications
Learn how to use the IS Deployments API to deploy all the 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 (physical star system) that includes the InsuranceSuite applications that you deploy. |
planetId | ID of a planet to which you deploy 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 (physical 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 for the specified branch.
[
{
"id": "cm/6",
"application": "cm",
...
},
{
"id": "cc/1",
"application": "cc",
...
},
{
"id": "pc/4",
"application": "pc",
...
}
]
Deploy the applications
You must deploy all the applications or the operation will fail. For example, if a star system (physical star system) includes PolicyCenter, ContactManager, and ClaimCenter, the applications
array must contain three objects, one per application.
To choose application builds and deploy all of the applications, send the following POST
request:
curl -X 'POST' \
'{baseURL}/api/v1/tenants/{tenantId}/starsystems/{projectId}/planets/{planetId}/deploy' \
-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, ContactManager, and PolicyCenter applications, use:
{
"applications": [
{
"application": "cc",
"buildId": "cc/16/15"
},
{
"application": "cm",
"buildId": "cm/10/16"
},
{
"application": "pc",
"buildId": "pc/8/8"
}
]
}
The environmentVariables
parameter is deprecated and will be removed soon. To manage environment variables, use the Variables app instead. For details, see Variables.
Check the deployment status
To check if the 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 deployment is completed when the value of phase
is DEPLOYED
. If the deployment fails, you can try to deploy the applications with different builds.
{
"phase": "DEPLOYED",
"environmentId": "test",
"deploymentId": "x000xx00-x000-0xxx-0x0x-000xxx0x0x0x",
"activityName": "DeployJob",
"operationInProgress": false,
"phaseDetails": "Deployed",
"applications": [
{
...
}
]
}