Start stream
Resume the background consumer task for a `kafka`/`nats` Data Source that was previously stopped (via [Stop stream](/docs/api-reference/streams/projects-project-streams-dsname-stop-get)) or never started, without recreating the Data Source itself.
Resume the background consumer task for a kafka/nats Data Source that
was previously stopped (via Stop stream)
or never started, without
recreating the Data Source itself.
Authorization
SymetryMLAuth HMAC-SHA256 signature-based authentication: requests are signed with
your secret key and sent with the Customer-ID, Sym-date,
Authorization, Content-MD5 and sym-version headers.
See SymetryML REST API Security
for the signature algorithm and a complete example.
In: header
Path Parameters
User/Customer identifier
Project identifier
Data source name
Query Parameters
Kafka only: consume the topic from its earliest offset instead of only new records.
falseResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/c1/projects/nbra_prj_iris/streams/nbra_ds_sftp_iris/start"{ "statusCode": 200, "statusString": "DS Stream started kafka stream with name [kafka_stream_0] for customer [c1]", "values": {}}{ "statusCode": 400, "statusString": "Customer[c1] does not have project with id[nosuchprj], ", "values": {}}{ "statusCode": 500, "statusString": "Generic Exception [java.lang.Exception: Stream [kafka_stream_0] is already running]", "values": {}}Get stream metrics GET
Return live consumer metrics for a running stream. Requires the stream to currently be running. Every stream type reports these three SML metrics: | Key | Meaning | |---|---| | `sml.tuples.num` | Records consumed so far | | `sml.tuples.rpms` | Throughput, records per millisecond | | `sml.stream.on` | `"true"` while the consumer task is active | **Kafka streams additionally return the entire underlying Kafka consumer metric set** — roughly 165 extra entries whose keys are the `toString()` of Kafka's own `MetricName` (e.g. `MetricName [name=bytes-consumed-total, group=consumer-fetch-manager-metrics, description=..., tags={client-id=...}]`). These are passed through verbatim from the Kafka client and are not part of SymetryML's contract; treat only the three `sml.*` keys as stable. NATS streams return the three `sml.*` keys alone.
Stop stream GET
Suspend the background consumer task for a running `kafka`/`nats` Data Source without detaching/deleting it — the Data Source remains attached to the project and can be resumed with [Start stream](/docs/api-reference/streams/projects-project-streams-dsname-start-get).