Delete Pipeline

Permanently delete a pipeline and its associated resources

Overview

Permanently delete a pipeline and all its associated jobs, runs, and scheduled tasks. This operation cannot be undone.

Required Headers

HeaderRequiredDescription
customer_nameYesCustomer identifier for authorization

Example

Delete a Pipeline

DELETE /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d

Headers:

customer_name: acme_corp

Response (200 OK):

{
  "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
  "status": "PIPELINE_DELETED"
}

What Gets Deleted

When you delete a pipeline, the following resources are permanently removed:

ResourceDescription
Pipeline recordThe pipeline metadata and configuration
JobsAll jobs associated with the pipeline
Job statesIncremental state, connector state records
Pipeline runsHistorical execution records
Scheduled DAGThe orchestration DAG is removed

Error Responses

401 Unauthorized - Missing customer_name Header

{
  "msg": "Unauthorized"
}

404 Not Found

{
  "detail": "pipeline_id invalid_pipeline_id not found!!"
}

500 Internal Server Error

{
  "detail": "Unable to complete transaction due to database error"
}

Important Considerations

Before Deleting

  • Verify the pipeline ID - Deletion is permanent and cannot be undone
  • Check for running executions - Consider pausing the pipeline first
  • Export configuration - If needed, retrieve the pipeline configuration using GET /platform/pipeline/:pipelineId

What is NOT Deleted

  • Destination tables - Data already loaded to Snowflake remains intact
  • Source data - Original data in source systems is not affected
  • Connection configurations - Credentials in Connection Manager remain available

Use Cases

Clean Up Test Pipelines

# Delete a test pipeline
DELETE /platform/pipeline/test_pipeline_12345

Remove Deprecated Pipelines

# First, pause the pipeline (optional but recommended)
POST /platform/pipeline/pause
{
  "customer_id": "acme_corp",
  "pipeline_id": "old_pipeline_abc123"
}

# Then delete
DELETE /platform/pipeline/old_pipeline_abc123

Notes

  • The customer_name header is required for authorization
  • Deletion triggers cleanup of the scheduled DAG in the orchestration system
  • This is a destructive operation - consider using POST /platform/pipeline/pause first if you might need the pipeline again
  • To recreate a deleted pipeline, you'll need to submit a new pipeline configuration via POST /platform/pipeline
Language
Credentials
Header
Click Try It! to start a request and see the response here!