API Reference

Connect to a stream WebSocket

get
https://example.com/api/v2/streams//ws

Opens a same-origin WebSocket for a node-bound stream using its secret or a participant-validated user token.

Path Params
uuid
required

Resource identifier.

Query Params
string

Participant-validated user token for a browser WebSocket connection.

string

Capability secret returned when the stream subscription was created.

string

Configured validator-node identifier. Defaults to the deployment's default node.

string

Same token as the jwt header; use the header except for clients that cannot set it.

Headers
string

Configured validator-node identifier; the query value takes precedence.

string

Canton Ledger API JWT used to authenticate the caller and resolve current party rights.

Responses

Updated 3 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago

Did this page help you?