Get pipeline deletion status by ID - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Retrieves the deletion status of a pipeline within a project.

HTML

GET https://hostname/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/deletion-status

This endpoint provides real-time status information about ongoing pipeline deletion operations, including the progress of individual deletion stages.

Process Overview

  • This endpoint checks the current deletion status of the specified pipeline from cache
  • Returns detailed status information including overall progress and individual stage statuses.

Key Features

  • Enables users to monitor the deletion progress of a pipeline.
  • Provides detailed status of all deletion stages.

Required Permissions

replication-pipeline::view

Request

Path parameters

Key Required Type Description
projectId Yes string

The unique identifier of the project containing the pipeline.
pipelineId Yes string

The unique identifier of the pipeline for which deletion status has to be retrieved.

Response

The successful response returns detailed status information including overall progress and individual stage statuses.

Response body properties

Property Required Type Description
pipelineName No string  
status No string

This property is an enumerated string type (enum) set to one of these values:

  • PENDING
  • IN_PROGRESS
  • COMPLETED
  • FAILED
stages No array  

Response examples

Example status code responses for this method are shown here.

Examples
"pipelineName": "test-pipeline",
"status": "IN_PROGRESS",
"stages": {
  "name": "STOP_PIPELINE",
  "status": "COMPLETED"
}
"stages": {
  "name": "DISABLE_CAPTURE",
  "status": "IN_PROGRESS"
}
"stages": {
  "name": "CLEAR_BACKLOG",
  "status": "PENDING"
}
"stages": {
  "name": "STOP_LOG_READER",
  "status": "PENDING"
}
"stages": {
  "name": "DELETE_PIPELINE",
  "status": "PENDING"
}

"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/projects/{projectId}/pipelines/{pipelineId}/deletion-status",
"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/projects/{projectId}/pipelines/{pipelineId}/deletion-status",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0002"
}
 

"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": "404",
"detail": "Pipeline deletion status not found",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/deletion-status",
"properties": {
  "errorCode": "DI-ADAPTER-STA-0008"
}


"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": "500",
"detail": "Failed to retrieve pipeline deletion status",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/deletion-status",
"properties": {
  "errorCode": "DI-ADAPTER-STA-0007"
}