Skip to main content

Node Operations API

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

Add Nodes to Stream​

Adds one or more nodes to an existing stream.

Endpoint​

POST /stream/streams/{id}/nodes

Path Parameters​

ParameterTypeDescription
idStringUnique identifier of the stream

Request Body​

[
  {
    "id": "64cb7ca2-ebca-4502-8fc4-208fa90545f4",
    "type": "EXECUTABLE_CONSUMER",
    "executable": "node /usr/share/engines/worker-scripts/Logger.js"
  }
]

Response​

{
  "id": "425ce7ec-a7af-497a-8d67-6371a32ad8bb",
  "success": true,
  "nodes": ["64cb7ca2-ebca-4502-8fc4-208fa90545f4"]
}

Remove Nodes from Stream​

Removes one or more nodes from an existing stream.

Endpoint​

DELETE /stream/streams/{id}/nodes

Path Parameters​

ParameterTypeDescription
idStringUnique identifier of the stream

Request Body​

["64cb7ca2-ebca-4502-8fc4-208fa90545f4"]

Response​

{
  "id": "425ce7ec-a7af-497a-8d67-6371a32ad8bb",
  "success": true,
  "nodes": ["64cb7ca2-ebca-4502-8fc4-208fa90545f4"]
}

Send Signal to Node​

Sends a signal to a specific node within a stream.

Endpoint​

POST /stream/streams/{id}/nodes/{nodeId}/signal

Path Parameters​

ParameterTypeDescription
idStringUnique identifier of the stream
nodeIdStringUnique identifier of the node

Request Body​

signal=start

Response​

{
  "id": "64cb7ca2-ebca-4502-8fc4-208fa90545f1",
  "streamId": "425ce7ec-a7af-497a-8d67-6371a32ad8bb",
  "signal": "start",
  "success": true
}