---
title: "Trigger clear operation for backlog rows"
method: POST
path: "/v1/integration/continuous/monitoring/projects/{projectId}/backlog/trigger"
tags: ["Monitor and Trigger Continuous Integration Projects"]
---

# Trigger clear operation for backlog rows

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

Submits an asynchronous clear operation for backlog rows associated with a pipeline 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.
- Validate that action is CLEAR and pipeline is specified.
- If `forced` is true, forcibly clear all backlog rows (may result in data loss for unreplicated rows).
- Dispatch clear 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 backlog clear operation for a specific pipeline.
- Forced clear option for data loss scenarios.
- 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

- TriggerBacklogRowsRequest: Request to trigger clear operation on backlog rows associated with a pipeline within a project
  - `pipeline` string, required: Name of the pipeline for which backlog rows should be cleared.
  - `forced` boolean: Set to true to force the clear operation. When forced, all backlog rows that have not been replicated for any data connection in the pipeline will be deleted. This may result in data loss.
  - `action` 'CLEAR', required: Action to perform on the backlog rows.

## 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)