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

# Trigger start/stop actions for capture

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

Submits an asynchronous lifecycle action (START or STOP) for capture operations on all or specified table identifiers in a pipeline. 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 table identifiers omitted/empty, action applies to all table identifiers in the pipeline.
- 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 capture control (omit table identifiers for ALL, supply list for specific table identifiers).
- 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

- TriggerCaptureRequest: Request to trigger lifecycle actions (START or STOP) for a Capture operation on all or specified table identifiers associated with a pipeline within a project.
  - `pipeline` string, required: Name of the pipeline for which the capture operation should be triggered.
  - `tables` TableIdentifier[]: List of fully qualified table identifiers (database, schema, table) to target for the capture operation. If empty or not provided, the action applies to all tables in the pipeline.
    - `database` string: Name of the database containing the table
    - `schema` string: Schema (namespace) within the database that contains the table
    - `table` string: Name of the table to operate on. Required when specifying individual tables.
  - `action` 'START' | 'STOP', required: Action to perform on the capture operation.

## 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 or pipeline not found
- `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)