Skip to main content

Delete Pipe

DELETE /public/v1/pipes/{id}​

Deletes a pipe. A pipe that is still running, paused or failed is stopped first.

Together with the pipe, Kadeck deletes its consumer group kadeck-pipe-<id> on the source cluster. The records the pipe wrote stay in the target topic.


Request​

Path Parameters​

ParameterTypeDescriptionRequired
idstring (UUID)Identifier of the pipeYes

Example Request​

curl --location --request DELETE 'https://your-instance.com/public/v1/pipes/4551b12c-e35d-4d79-b6b4-5cb04cdf8f6a' \
--header 'Authorization: Bearer <your-api-key>'

Response​

HTTP Status Code: 204 No Content
Response Body: (empty)


Possible Errors​

Status CodeDescriptionSolution
401UnauthorizedCheck your API key
403The API key may see the pipe but lacks the right to manage itIt needs to read the source topic and write the target topic
404The pipe does not exist or is not visible to the API keyCheck the id

Best Practices​

  • Deleting a pipe cannot be undone. The pipe, its figures and its position are gone.
  • Keep stopped and completed pipes as long as you want to look up what they did: they are part of the data flow shown in the Catalog.