Monitor and Trigger Continuous Integration Projects

Trigger start/stop actions for runtime engines

Submits an asynchronous lifecycle action (START or STOP) for one or more continuous replication runtime engines 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.
  • If engines omitted/empty, action applies to all engines in the project.
  • 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 engine control (omit list for ALL, supply list for specific engines).
  • 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}/engines/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}/engines/trigger
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project whose runtime engines should be acted upon.

Request body

enginesstring[]

List of engine names to target for the operation. If empty or not provided, the action applies to all available engines in the project.

action'START' | 'STOP' required

Action to perform on the engines.

Example request

{
  "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.