Build and Configure Continuous Integration Projects

Activate a project

Stages and optionally activates a project, with optional pipeline start.

Process Overview:

  • Based on the ProjectActivationRequest, this endpoint triggers the appropriate operations in a fixed sequence: validate, stage, activate, then start pipelines.
  • If validate is true, pipeline activation readiness is validated before staging or before activation. When validateOptions.pipelineIds is provided, those pipelines are validated first as a pipeline-level pre-check; the full project is still validated afterward regardless.
  • If stage is true, the project configurations are staged, and the user is redirected to the staging status endpoint.
  • If activate is true, the project is activated, and the user is redirected to the alerts endpoint.
  • If startPipelines is true, the pipelines associated with the project are started.
  • If stage, activate, and startPipelines are all false but validate is true, the same readiness pre-check runs and a full-project validation is triggered directly, without staging.

Redirect Details:

  • When stage is true, the Location header in the response contains the URI to monitor the staging status of the project.
  • When activate is true, the Location header in the response contains the URI to the project's alerts endpoint.
  • Clients can use the Location header to navigate to the appropriate endpoint for further actions.

Key Features:

  • Allows users to manage the lifecycle of a project (staging, activation, pipeline starting).
  • Provides redirection to relevant endpoints based on the operation performed.
  • Ensures that the operations are performed asynchronously where applicable.

Required Permissions: Either replication-pipeline::create or replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.

post/v1/integration/continuous/projects/{projectId}/activation

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/activation
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The unique identifier of the project to activate.

Request body

validateboolean

Flag to indicate whether pipeline activation readiness should be validated before staging is committed

stageboolean required

Flag to indicate whether the project should be staged

activateboolean required

Flag to indicate whether the project should be activated

startPipelinesboolean required

Flag to indicate whether pipelines within the project should be started

Example request

{
  "validate": true,
  "stage": true,
  "stagingOptions": {
    "type": "INCREMENTAL_COMMIT"
  },
  "activate": true,
  "activationOptions": {
    "queueTimeoutInMinutes": 4,
    "stopRequestTimeoutInMinutes": 4,
    "tableCaptureTimeoutInMinutes": 8
  },
  "startPipelines": true
}

Response

Project activation or staging initiated successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.