Skip to main content

Pipe Operations API

The Streams Engine provides several endpoints for managing pipes that connect nodes within a stream. This page documents the request and response formats for these operations.

Add Pipes to Stream​

Adds one or more pipes to an existing stream using YAML format.

Endpoint​

POST /stream/streams/{id}/pipes/yaml

Path Parameters​

ParameterTypeDescription
idStringUnique identifier of the stream

Request Body​

The request body should contain a YAML string with pipe definitions:

---
- id: 425ce7ec-a7af-497a-8d67-6371a32ad8bb
  source: 64cb7ca2-ebca-4502-8fc4-208fa90545f1
  destination: 64cb7ca2-ebca-4502-8fc4-208fa90545f4

Response​

{
  "id": "425ce7ec-a7af-497a-8d67-6371a32ad8bb",
  "pipes": ["67a7a083-28b0-4dd5-b33d-e60e339bb93z"],
  "success": true
}

Remove Pipes from Stream​

Removes one or more pipes from an existing stream.

Endpoint​

DELETE /stream/streams/{id}/pipes

Path Parameters​

ParameterTypeDescription
idStringUnique identifier of the stream

Request Body​

["67a7a083-28b0-4dd5-b33d-e60e339bb93z"]

Response​

{
  "id": "425ce7ec-a7af-497a-8d67-6371a32ad8bb",
  "pipes": ["67a7a083-28b0-4dd5-b33d-e60e339bb93z"],
  "success": true
}