SymetryML Documentation
Streams

Browse stream sources

List the topics/streams available on a Kafka or NATS JetStream server, without creating a Data Source. Distinct from `POST /{user}/projects/dsbrowse`, which browses file-based data sources (S3, SFTP, etc.) — this endpoint only understands `kafka` and `nats` in `values.type`. * **Kafka**: always returns a flat list of topics in `values.files`, each formatted as `<topic name>:<partition count>`. Topics starting with `_` (internal Kafka topics) are excluded. `values.path` is ignored. * **NATS**: if `values.path` is empty/omitted, returns the JetStream **stream** names in `values.dirs`. If `values.path` is set to a stream name, returns the **subjects** within that stream in `values.files`, echoing the stream name back in `values.path`. An unknown NATS stream name is **not** an error: the response is a `200` whose `dsdirectoryListing` carries only `ok: true`, with neither `dirs` nor `files`. `ok` defaults to `true` and is present on every response; unset list/path fields are omitted from the JSON entirely.

POST
/{user}/streams/browse

List the topics/streams available on a Kafka or NATS JetStream server, without creating a Data Source. Distinct from POST /{user}/projects/dsbrowse, which browses file-based data sources (S3, SFTP, etc.) — this endpoint only understands kafka and nats in values.type.

  • Kafka: always returns a flat list of topics in values.files, each formatted as <topic name>:<partition count>. Topics starting with _ (internal Kafka topics) are excluded. values.path is ignored.
  • NATS: if values.path is empty/omitted, returns the JetStream stream names in values.dirs. If values.path is set to a stream name, returns the subjects within that stream in values.files, echoing the stream name back in values.path.

An unknown NATS stream name is not an error: the response is a 200 whose dsdirectoryListing carries only ok: true, with neither dirs nor files. ok defaults to true and is present on every response; unset list/path fields are omitted from the JSON entirely.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

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*string

User/Customer identifier

Query Parameters

skipHidden?boolean

Accepted but currently ignored — the corresponding logic is commented out server-side.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Encrypted DSListingRequest

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/c1/streams/browse" \  -H "Content-Type: application/json" \  -d '6TYsk+/zj32PJvmeT7FY7mT9yn0IpjSN2KcM1mRkpZEwbDiTsm04CcXJYQWm2r42q0JZnvZ43pFg9hutZhonwtVZkg5x5W4Bk2rhZoAGhD1iCSREqWLRKgPvv2Gdw3yHJj0wEx9O70d21p9VF/uEDXtMsIgFSdZeuLNStZJoUYvWuSmDxMRGznKILNRw8FNTIdNlQ61TWBrTBcWVKFqQoA=='

{  "statusCode": 200,  "statusString": "OK",  "values": {    "dsdirectoryListing": {      "ok": true,      "dirs": [        "SML_JS_TEST",        "browse",        "cont_rnd_csv",        "csv_update"      ]    }  }}

{  "statusCode": 200,  "statusString": "string",  "values": {    "cellsStatusEncrypted": "BASE64ENCODED_CBC_CIPHERTEXT",    "cifPredictionList": {      "values": [        {          "sdfmap": {            "property1": {              "errorHandling": 0,              "attributeNames": [                "string"              ],              "attributeTypes": [                "string"              ],              "data": [                [                  "string"                ]              ]            },            "property2": {              "errorHandling": 0,              "attributeNames": [                "string"              ],              "attributeTypes": [                "string"              ],              "data": [                [                  "string"                ]              ]            }          }        }      ]    },    "dataframe": {      "errorHandling": 0,      "attributeNames": [        "string"      ],      "attributeTypes": [        "string"      ],      "data": [        [          "string"        ]      ]    },    "dcfitresult": {      "scoreThresholdValues": [        [          0.1        ]      ],      "featuresUse": [        "string"      ]    },    "dcinfo": {      "inputAttributes": [        "string"      ],      "driftParameters": {        "property1": "string",        "property2": "string"      },      "mahalanobisParameters": {        "property1": "string",        "property2": "string"      },      "pcaRecParameters": {        "property1": "string",        "property2": "string"      }    },    "densityList": {      "values": [        {          "attrName": "string",          "min": 0.1,          "max": 0.1,          "width": 0.1,          "histogram": [            0.1          ],          "valueForMissing": 0.1,          "error": "string"        }      ]    },    "dsdirectoryListing": {      "ok": true,      "files": [        "string"      ],      "dirs": [        "string"      ],      "path": "string",      "marker": "string",      "delimiter": "string"    },    "dsinfo": {      "type": "s3",      "name": "string",      "attributeNames": [        "string"      ],      "attributeTypes": [        "C"      ],      "info": {        "property1": "string",        "property2": "string"      }    },    "encoderInfo": {      "target": "string",      "minTrimSize": "string"    },    "encryptedGroupInfo": "BASE64ENCODED_CBC_CIPHERTEXT",    "errorstring": "string",    "fedInfoEncrypted": "BASE64ENCODED_CBC_CIPHERTEXT",    "fedSyncStats": {      "sndCount": 0,      "sndContractError": 0,      "rcvCount": 0,      "rcvError": 0,      "rcvContractError": {        "property1": 0,        "property2": 0      },      "errorLog": [        "string"      ],      "syncLog": [        "string"      ]    },    "jobinfo": {      "jobId": 0,      "jobType": "string",      "owner": "string",      "startingDate": 0,      "maximum": 0,      "current": 0,      "isOnBoundedExecutor": true,      "isStarted": true,      "isDone": true,      "details": {}    },    "jobinfolist": [      {        "jobId": 0,        "jobType": "string",        "owner": "string",        "startingDate": 0,        "maximum": 0,        "current": 0,        "isOnBoundedExecutor": true,        "isStarted": true,        "isDone": true,        "details": {}      }    ],    "kmResultList": {      "values": [        {          "property1": {            "errorHandling": 0,            "attributeNames": [              "string"            ],            "attributeTypes": [              "string"            ],            "data": [              [                "string"              ]            ]          },          "property2": {            "errorHandling": 0,            "attributeNames": [              "string"            ],            "attributeTypes": [              "string"            ],            "data": [              [                "string"              ]            ]          }        }      ]    },    "KSVDMap": {      "values": [        {          "property1": 0.1,          "property2": 0.1        }      ]    },    "KSVSMap": {      "values": [        {          "property1": "string",          "property2": "string"        }      ]    },    "modelInfo": {      "modelId": "string",      "modelType": "string",      "modelBuilt": 0,      "buildTime": 0,      "attributeNames": [        "string"      ],      "attributeTypes": [        "string"      ],      "attributeIndexes": [        0      ],      "targetNames": [        "string"      ],      "targetIndexes": [        0      ],      "predictInfo": [        "string"      ],      "scoreInfo": [        "string"      ],      "creationDate": 0,      "useShortDesc": true,      "info": {},      "extra": {}    },    "pcaSumValues": 0,    "pcaValues": {      "errorHandling": 0,      "attributeNames": [        "string"      ],      "attributeTypes": [        "string"      ],      "data": [        [          "string"        ]      ]    },    "pcaVectors": {      "errorHandling": 0,      "attributeNames": [        "string"      ],      "attributeTypes": [        "string"      ],      "data": [        [          "string"        ]      ]    },    "sdfResults": {      "sdfmap": {        "property1": {          "errorHandling": 0,          "attributeNames": [            "string"          ],          "attributeTypes": [            "string"          ],          "data": [            [              "string"            ]          ]        },        "property2": {          "errorHandling": 0,          "attributeNames": [            "string"          ],          "attributeTypes": [            "string"          ],          "data": [            [              "string"            ]          ]        }      }    },    "smlInfo": {      "pid": "string",      "type": "cpu",      "encoderName": "string",      "modelsList": [        "string"      ],      "modelTypeList": [        "bayes"      ],      "dsList": [        "string"      ],      "streams": [        "string"      ],      "attributeNames": [        "string"      ],      "attributeIndexes": [        0      ],      "attributeTypes": [        "C"      ],      "partitionColumn": "string",      "creationDate": 0,      "lastModificationDate": 0,      "loaded": true,      "persisted": true,      "histogramEnabled": true,      "params": {        "property1": "string",        "property2": "string"      }    },    "smlInfoList": {      "projects": [        {          "pid": "string",          "type": "cpu",          "encoderName": "string",          "modelsList": [            "string"          ],          "modelTypeList": [            "bayes"          ],          "dsList": [            "string"          ],          "streams": [            "string"          ],          "attributeNames": [            "string"          ],          "attributeIndexes": [            0          ],          "attributeTypes": [            "C"          ],          "partitionColumn": "string",          "creationDate": 0,          "lastModificationDate": 0,          "loaded": true,          "persisted": true,          "histogramEnabled": true,          "params": {            "property1": "string",            "property2": "string"          }        }      ]    },    "smlOptions": {},    "status": "string",    "string": "string",    "stringList": {      "values": [        "string"      ]    },    "stringToSign": "string"  }}

{  "statusCode": 500,  "statusString": "Generic Exception [java.io.IOException: Unable to connect to NATS servers: [nats://asdfasdbad:4222]]",  "values": {}}

List streams GET

List the `kafka`/`nats` Data Sources attached to a project (both running and stopped streams are included — this is a DS-attachment listing, not a running-task listing).

Stop and evict a polled stream DELETE

Stop and remove a [Poll stream](/docs/api-reference/streams/streams-poll-post) poller for the given `sid` from the server-side cache. This does not touch the underlying `kafka` Data Source's lifecycle managed by [Create stream](/docs/api-reference/streams/projects-project-streams-create-post)/ [Start stream](/docs/api-reference/streams/projects-project-streams-dsname-start-get)/ [Stop stream](/docs/api-reference/streams/projects-project-streams-dsname-stop-get)/ [Delete stream](/docs/api-reference/streams/projects-project-streams-dsname-delete) — it only tears down the on-demand poller and, if the `sid` also identifies a registered Data Source, deletes that Data Source too.