---
title: "Trigger start/stop actions for specified log reader"
method: POST
path: "/v1/integration/continuous/monitoring/projects/{projectId}/logreaders/trigger"
tags: ["Monitor and Trigger Continuous Integration Projects"]
---

# Trigger start/stop actions for specified log reader

`POST /v1/integration/continuous/monitoring/projects/{projectId}/logreaders/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}/logreaders/trigger`
- Auth: HTTP bearer

Submits an asynchronous lifecycle action (START, STOP) for log reader associated with pipeline within the specified 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.
- Validate that at least logReader or pipeline is specified in the request.
- 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:
- Targeted log reader control (specify logReader and associating pipeline).
- 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`

## Path parameters

- `projectId` string, required

## Request body

- TriggerLogReaderRequest: Request to trigger lifecycle actions (START or STOP) for a log reader within a project.
  - `pipeline` string, required: Name of the pipeline in which associated log reader has to be triggered.
  - `logReader` string, required: Name of the log reader to trigger.
  - `startOptions` LogReaderStartOptions: Options for starting a log reader, including warm start and offset details.
    - `warmStart` boolean: Whether Resume from last read (Warm) or Specify receiver and sequence location(Cold).
    - `receiverType` 'CURRENT' | 'CURRENT_CHAIN' | 'SPECIFY': Receiver type: CURRENT, CURRENT_CHAIN, or SPECIFY. Required for START.
    - `receiverOffset` integer: Receiver offset if receiverType is SPECIFY. Required for START and SPECIFY.
    - `sequenceType` 'FIRST' | 'LAST' | 'SPECIFY': Sequence type: LAST, FIRST, or SPECIFY. Required for START.
    - `sequenceOffset` integer: Sequence offset if sequenceType is SPECIFY. Required for START and SPECIFY.
  - `action` 'START' | 'STOP', required: Action to perform on the log readers.

## Response `202`

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

- TriggerOperationResponse: Acknowledgement response indicating the submitted trigger request for specified operation was accepted.
  - `message` string: Informational message describing the outcome of the submission.
  - `status` 'Submitted' | 'InProgress' | 'Completed' | 'Partial' | 'Failed' | 'Cancelled': Overall submission status of the trigger request.

## Other responses

- `400`: Invalid request payload
- `401`: Unauthorized - Authentication required
- `403`: Forbidden - User lacks 'replication-pipeline::operate' permission
- `404`: Project, log reader, or pipeline not found
- `422`: Unprocessable Entity - Validation failed due to one of the following reasons: - For Start Action, the start options are not defined - If warm start is not desired, the receiver and sequence details are not defined - If the receiver type is `SPECIFY`, `receiverOffset` is not defined - If the sequence type is `SPECIFY`, `sequenceOffset` is not defined
- `500`: Internal Server Error - Failed to submit trigger request

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)