Skip to main content

Pipeline API (DAG Compiler)

Handles pipeline lifecycle — from draft creation through compilation to Flink deployment. Deploys via Temporal workflows.

FieldValue
Port50002
Base Path/api/v1
OpenAPI3.1.0
SpecPIPELINE_API.json

Pipeline Lifecycle


Pipeline CRUD

MethodPathRequest BodyResponseStatus
POST/api/v1/pipelinesPipelineSaveRequestPipelineSaveResponse201
GET/api/v1/pipelines/{id}PipelineDetailResponse200
PUT/api/v1/pipelines/{id}PipelineSaveRequestPipelineSaveResponse200
DELETE/api/v1/pipelines/{id}204

Pipeline Lifecycle Control

MethodPathDescriptionResponse
POST/api/v1/pipelines/{id}/compileCompile pipeline DAGCompileResponse
POST/api/v1/pipelines/{id}/deployDeploy to Flink via TemporalDeployResponse
GET/api/v1/pipelines/{id}/statusGet deployment statusPipelineStatusResponse
POST/api/v1/pipelines/{id}/pausePause running pipelinePipelineStatusResponse
POST/api/v1/pipelines/{id}/resumeResume paused pipelinePipelineStatusResponse
POST/api/v1/pipelines/{id}/cancelCancel pipelinePipelineStatusResponse
POST/api/v1/pipelines/{id}/restoreRestore from savepointPipelineStatusResponse
POST/api/v1/pipelines/{id}/purgePurge pipeline state204

Savepoint Management

MethodPathDescription
GET/api/v1/pipelines/{id}/savepointsList savepoints
POST/api/v1/pipelines/{id}/savepoints/triggerTrigger savepoint
DELETE/api/v1/pipelines/{id}/savepoints?path=Delete savepoint
POST/api/v1/pipelines/{id}/savepoints/validate?path=Validate savepoint
GET/api/v1/pipelines/{id}/savepoints/info?path=Get savepoint info
POST/api/v1/pipelines/{id}/savepoints/cleanupCleanup old savepoints

Execution & Monitoring

MethodPathDescription
GET/api/v1/pipelines/{id}/executionsList execution instances
GET/api/v1/pipelines/{id}/checkpointsList checkpoints
GET/api/v1/pipelines/{id}/kafka/offsetsGet Kafka consumer offsets

Operator Configuration

MethodPathDescription
GET/api/v1/operator-configurations/{id}Get config (UUID)
PUT/api/v1/operator-configurations/{id}Update config (partial, Apicurio validated)
DELETE/api/v1/operator-configurations/{id}Soft delete config

Response Envelope

{
"status": "success",
"data": { ... },
"message": "Pipeline compiled successfully",
"errors": []
}

Status Codes

CodeMeaning
200Success
201Created
204No Content (delete/purge)
400Invalid request / validation error
404Pipeline not found
409Conflict (duplicate name)
422Schema validation failed (Apicurio)
500Internal server error

Frontend Integration

FilePurpose
services/pipeline/pipeline.service.tsPipeline CRUD & lifecycle
services/pipeline/pipeline-validation.service.tsClient-side validation
services/pipeline/operator-sync.service.tsOperator config sync
services/pipeline/pipeline-transform.service.tsDTO transformations
types/pipeline.tsTypeScript types
stores/usePipelineStore.tsZustand canvas state