Submits an asynchronous lifecycle action (START or STOP) for capture operations on all or specified table identifiers in a pipeline.
HTML
POST https://hostname/v1/integration/continuous/monitoring/projects/{projectId}/capture/triggerProcess 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
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project whose capture should be acted upon. |
Request body properties
| Property | Required | Type | Description |
|---|---|---|---|
| pipeline | Yes | string |
|
| tables | No | array | |
| action | Yes | string |
This property is an enumerated string type (enum) set to one of these values:
|
Request body example
"pipeline":"orders",
"tables": {
"database":"sales_db",
"schema":"public",
"table":"orders"
}
"tables": {
"database":"sales_db",
"schema":"public",
"table":"customers"
}
"action":"START"Response
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.
Header keys
| Key | Required | Type | Description |
|---|---|---|---|
| Location | No | string | URL of the project alerts endpoint for monitoring post-trigger alerts. |
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| message | No | string | |
| status | No | string |
This property is an enumerated string type (enum) set to one of these values:
|
Response examples
Example status code responses for this method are shown here.
"message": "request START submitted",
"status": "SUBMITTED""type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": "400",
"detail": "Validation error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger",
"properties":
{
"errorCode": "DI-ADAPTER-VAL-0000"
}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": "401",
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0001
"}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": "403",
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0002"
}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": "404",
"detail": "Not Found - Resource does not exist",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger",
"properties": {
"errorCode": "DI-ADAPTER-PRJ-0005"
}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": "500",
"detail": "An unexpected error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger",
"properties": {
"errorCode": "DI-ADAPTER-CPT-0006"
}