Skip to content

Update docs for adding originCluster into SSST #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yichen-dlb wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update docs for adding originCluster into SSST #530

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46cc439
Update docs for adding originCluster into SSST
yichen-dlb Feb 24, 2026
68db1b5
Fix link
yichen-dlb Feb 26, 2026
7d5df2e
Merge branch 'main' into sst-origin
yichen-dlb Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions millicast/changelog/changelog-rest-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Updates to [REST APIs](/millicast/api/analytics-account-total), and [Webhooks](/millicast/webhooks/).

## 2026-02-26 | REST APIs

### Features

- Allow specification of `originCluster` via [Self Signed Subscribe Tokens](millicast/subscribe-tokens/#creating-a-self-signed-token)
Comment thread
MattiasBuelens marked this conversation as resolved.
Outdated

## 2026-02-23 | REST APIs

### Features
Expand Down
8 changes: 5 additions & 3 deletions millicast/streaming-dashboard/subscribe-tokens.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ Self-signing your Subscribe token allows you to:
- `trackingId` (optional): A group ID to syndicate content across multiple partners or providers. This ID can be used to group viewers of the same stream for [analytics](/millicast/api/analytics-get-tracking-total-for-streams.api.mdx) purposes. _Note: This is intended for tracking groups of viewers and should **NOT** be unique per-viewer. If you want to track individual viewers, see `customViewerData`_
- `expires_in` (optional): Number of seconds before the token expires. If the parent token expires before the self-signed token, the self-signed token will also expire.
- `customViewerData` (optional): A unique identifier of a viewer that allows getting the viewer's bandwidth consumption while using [syndication](/millicast/distribution/syndication). Using this parameter requires contacting sales.
- `originCluster` (optional): Specify cluster to route subscriber to, provided it is a subset of the `originCluster` set on the (primary) subscribe token.

@craig-johnston craig-johnston Feb 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think better to say it can only be set to any valid cluster if the signing token uses "auto" for the originCluster.
or it can be set to the same value as the signing token.
Since it's optional, may as well just not specify the value in the second case.

@yichen-dlb yichen-dlb Feb 26, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @craig-johnston, wanted to double check if you wanted me to capture everything you had in your comment or can I keep it short:

Specifies the cluster to route the subscriber to. Set to any valid cluster if the primary subscribe token is configured to "auto" for `originCluster`.

We should just leave out the comment regarding the second case.

3. Sign the JWT using the Subscribe token as the key and set an expiration for the JWT.

_Note: Either or both `trackingId` and/or `customViewerData` may be used depending on what kind of tracking you need to achieve._
Expand All @@ -162,17 +163,18 @@ To put it all together, here is an example `payload` for a JWT that includes sam
"tracking": {
"trackingId": "groupAbc"
},
"customViewerData": "user=user123;appVersion=x.y.x"
"customViewerData": "user=user123;appVersion=x.y.x",
"originCluster": "cluster-id"
},
"iat": 1750813271,
"exp": 1750813871 // required for the token to be valid
}
```

Here is the JWT that is used to generate this token, you can paste it into [jwt.io](https://jwt.io/#token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdHJlYW1pbmciOnsidG9rZW5JZCI6MTIzNDUsInRva2VuVHlwZSI6IlN1YnNjcmliZSIsInN0cmVhbU5hbWUiOiJteVN0cmVhbU5hbWUiLCJ0cmFja2luZyI6eyJ0cmFja2luZ0lkIjoiZ3JvdXBBYmMifSwiY3VzdG9tVmlld2VyRGF0YSI6InVzZXI9dXNlcjEyMzthcHBWZXJzaW9uPXgueS54In0sImlhdCI6MTc1MDgxMzI3MSwiZXhwIjoxNzUwODEzODcxfQ.pP5Kg6fCJfTaCc_OaV1FV5votZjy8x1gfJ2F7tQXj7c).
Here is the JWT that is used to generate this token, you can paste it into [jwt.io](https://jwt.io/#token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdHJlYW1pbmciOnsidG9rZW5JZCI6MTIzNDUsInRva2VuVHlwZSI6IlN1YnNjcmliZSIsInN0cmVhbU5hbWUiOiJteVN0cmVhbU5hbWUiLCJ0cmFja2luZyI6eyJ0cmFja2luZ0lkIjoiZ3JvdXBBYmMifSwiY3VzdG9tVmlld2VyRGF0YSI6InVzZXI9dXNlcjEyMzthcHBWZXJzaW9uPXgueS54Iiwib3JpZ2luQ2x1c3RlciI6ImNsdXN0ZXItaWQifSwiaWF0IjoxNzUwODEzMjcxLCJleHAiOjE3NTA4MTM4NzF9.btau2liawfvZeYdgV2RwV5F3CrV_Vl0a2ePSV1anDII).

```text
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdHJlYW1pbmciOnsidG9rZW5JZCI6MTIzNDUsInRva2VuVHlwZSI6IlN1YnNjcmliZSIsInN0cmVhbU5hbWUiOiJteVN0cmVhbU5hbWUiLCJ0cmFja2luZyI6eyJ0cmFja2luZ0lkIjoiZ3JvdXBBYmMifSwiY3VzdG9tVmlld2VyRGF0YSI6InVzZXI9dXNlcjEyMzthcHBWZXJzaW9uPXgueS54In0sImlhdCI6MTc1MDgxMzI3MSwiZXhwIjoxNzUwODEzODcxfQ.pP5Kg6fCJfTaCc_OaV1FV5votZjy8x1gfJ2F7tQXj7c
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdHJlYW1pbmciOnsidG9rZW5JZCI6MTIzNDUsInRva2VuVHlwZSI6IlN1YnNjcmliZSIsInN0cmVhbU5hbWUiOiJteVN0cmVhbU5hbWUiLCJ0cmFja2luZyI6eyJ0cmFja2luZ0lkIjoiZ3JvdXBBYmMifSwiY3VzdG9tVmlld2VyRGF0YSI6InVzZXI9dXNlcjEyMzthcHBWZXJzaW9uPXgueS54Iiwib3JpZ2luQ2x1c3RlciI6ImNsdXN0ZXItaWQifSwiaWF0IjoxNzUwODEzMjcxLCJleHAiOjE3NTA4MTM4NzF9.btau2liawfvZeYdgV2RwV5F3CrV_Vl0a2ePSV1anDII
```

To see the validation tool validate the token, insert the random token used to sign the JWT: `d2e166fdda89824a6c493d8a2af7a0754199eff9e38c579cba8783767a44039c`.
Expand Down
Loading