Skip to content

Add doc about possible streaming hostname configuration value #1789

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add doc about possible streaming hostname configuration value #1789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions content/en/methods/streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ aliases: [
#TableOfContents ul ul ul {display: none}
</style>

## Hostname discovery

Depending on server configuration details, the streaming API may be served from a different hostname than the other portions of the REST API. All path values documented here are relative to that hostname value. Clients should first obtain the hostname value by either:

- Extracting the `configuration.urls.streaming` value from the [instance endpoint](../instance).
- Making a REST API request to the `api/v1/streaming` endpoint on the regular host. This will redirect to the streaming server URL if configured, or return Not Found when the same host should be used.

## Event types and payloads {#events}

`update`
Expand Down