Monitor and Trigger Continuous Integration Projects

Trigger start/stop actions for pipelines

Submits an asynchronous lifecycle action (START or STOP) for one or more continuous replication pipelines in a project. A 202 Accepted response indicates the request was validated and dispatched (not that execution is complete). The response body contains a status field (SUBMITTED or FAILED) and the Location header points to the alerts endpoint for monitoring.

Process Overview:

  • Validate caller has replication-pipeline::operate permission.
  • Interpret request: (a) pipelines omitted/empty => target all pipelines in latest deployed snapshot; (b) pipelines provided => forward as-is.
  • If targeting all, fetch latest deployed snapshot and ensure at least one pipeline is available; fail otherwise.
  • If action = START, optionally treat resumeRequest=true as warm/resume start; if STOP, ignore resumeRequest.
  • Dispatch start or stop request through the portal client.
  • Build 202 response with body status (SUBMITTED if dispatch succeeded, FAILED if an internal exception occurred) and Location header to alerts.

Key Features:

  • Bulk or targeted pipeline control (omit list for ALL, supply list for specific pipelines).
  • Warm/resume semantics for START via resumeRequest flag.
  • Uniform 202 response; body-level status differentiates dispatch success vs failure.
  • Immediate monitoring path via Location header (/projects/{projectId}/alerts) for a successfully submitted request.
  • Idempotent friendly: client can safely retry on FAILED since execution had not been confirmed.

Required Permissions: replication-pipeline::operate

post/v1/integration/continuous/monitoring/projects/{projectId}/pipelines/trigger

Request

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

Path parameters

projectIdstring required

Unique identifier of the project whose pipelines should be acted upon.

Request body

pipelinesstring[] 
    List of pipeline names on which the action should be applied.
    If this is not provided, the action will be applied to all pipelines associated with the project.
resumeRequestboolean

Indicates whether this trigger is to resume a previously paused or failed request (idempotent retry).

action'START' | 'STOP' required

Action to perform on the specified pipelines.

Example request

{
  "pipelines": [
    "pipeline1",
    "pipeline2"
  ],
  "action": "START"
}

Response

Accepted. Body status field indicates SUBMITTED or FAILED; If the request is properly submitted, Location header points to alerts endpoint.

messagestring

Informational message describing the outcome of the submission.

status'Submitted' | 'InProgress' | 'Completed' | 'Partial' | 'Failed' | 'Cancelled'

Overall submission status of the trigger request.

Example response

{
  "message": "request START submitted",
  "status": "Submitted"
}

Changes

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