Configure deployment checks

Learn how to use the CI/CD Manager API to configure your deployment checks.

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

Parameter name	Description
tenantId	Tenant ID.
starSystemId	ID of the logical star system that includes the InsuranceSuite application for which you configure quality gates.
applicationId	InsuranceSuite application which includes the build. For example: - PC for PolicyCenter - BC for BillingCenter - CC for ClaimCenter - CM for ContactManager
qualityGateID	ID of a quality gate.

Create a deployment check

To create a new deployment check, send the following POST request:

curl -X 'POST' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'
    -d '{body}'

Where {body} is a JSON object that represents a quality gate:

Example request body

{
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "templateSettings": {
    "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
    "templateParameters": {
      "planetId": "dev"
    }
  },
  "description": "This Quality Gate verifies that an application build was successfully deployed on a given planet."
}

A response body contains a JSON object representing the newly created quality gate:

Example response body

{
  "id": "91211111-a8h2-c7jh-lki9-ac7ccc9a090o",
  "stage": "PRE_PROMOTION_PREPROD",
  "required": true,
  "name": null,
  "description": "This Quality Gate verifies that an application build was successfully deployed on a given planet.",
  "testMetadata": null,
  "branchFilter": null,
  "templateSettings": {
    "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
    "templateParameters": {
      "planetId": "dev"
    }
  }
}

Get a list of all the quality gates configured for a given stage

To list the already existing deployment checks for a given stage, send the following GET request:

curl -X 'GET' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates?stage={STAGE}&templateType=SUCCESSFUL_DEPLOYMENT_QUALITY_GATE
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'

Where STAGE represents the stage of the deployment check that you want to list. Currently, these are the supported deployment check stages:

• PRE_PROMOTION_PREPROD
• PRE_PROMOTION_PROD

A response body contains a JSON object with a list of all the existing deployment checks. For example, a request to list all the PRE_MERGE quality gates might get the following response:

Example response body

[
  {
    "id": "91211111-a8h2-c7jh-lki9-ac7ccc9a090o",
    "stage": "PRE_PROMOTION_PREPROD",
    "required": true,
    "name": null,
    "description": "This Quality Gate verifies that application build was successfully deployed on a given planet.",
    "testMetadata": null,
    "branchFilter": null,
    "templateSettings": {
      "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
      "templateParameters": {
        "planetId": "dev"
      }
    }
  },
  {
    "id": "91211111-a8h2-c7jh-lki9-ac7ccc9a0xcq",
    "stage": "PRE_PROMOTION_PREPROD",
    "required": true,
    "name": null,
    "description": "This Quality Gate verifies that build was successfully deployed on given planet.",
    "testMetadata": null,
    "branchFilter": null,
    "templateSettings": {
      "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
      "templateParameters": {
        "planetId": "int"
      }
    }
  }
]

Update a deployment check

To update a deployment check, send the following PUT request:

curl -X 'PUT' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates/{qualityGateId}
    -H 'accept: application/json' \
    -H 'Authorization: Bearer {access_token}'
    -d '{body}'

Where {body} is a JSON object that represents an updated deployment check:

Example request body

{
  "stage": "PRE_PROMOTION_PREPROD",
  "required": false,
  "templateSettings": {
    "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
    "templateParameters": {
      "planetId": "devtest"
    }
  },
  "description": "This Quality Gate verifies that an application build was successfully deployed on devtest."
}

You can modify only the following parameters:

• required
• description

A response body contains a JSON object representing the updated quality gate:

Example response body

{
  "id": "91211111-a8h2-c7jh-lki9-ac7ccc9a090o",
  "stage": "PRE_PROMOTION_PREPROD",
  "required": false,
  "name": null,
  "description": "This Quality Gate verifies that build was successfully deployed on dev.",
  "testMetadata": null,
  "branchFilter": null,
  "templateSettings": {
    "templateType": "SUCCESSFUL_DEPLOYMENT_QUALITY_GATE",
    "templateParameters": {
      "planetId": "devtest"
    }
  }
}

Delete a deployment check

To delete a deployment check that you no longer need, send the following DELETE request without any request body:

curl -X 'DELETE' \
    {baseUrl}/api/v3/tenants/{tenantId}/starsystems/{starSystemId}/applications/{applicationId}/quality-gates/{qualityGateId}
    -H 'Authorization: Bearer {access_token}'

You'll receive a response with HTTP code 204 and without any response body.