Skip to content

Live: write-only pull source credentials and one-time speech connection details - #982

Draft
erikdeweerdt wants to merge 3 commits into
mainfrom
live-credentials-shown-once
Draft

erikdeweerdt wants to merge 3 commits into
mainfrom
live-credentials-shown-once

Conversation

@erikdeweerdt

Copy link
Copy Markdown
Contributor

Summary

Documents two OptiView Live API behaviors that ship with the next Live API release:

  • Pull source credentials are write-only. For srt-pull, rtmp-pull and rtsp-pull sources, credentials in the source URL are never returned again, not even in create or update responses. Reads return the URL without them, with credentialHidden: true when something was removed. To change a source, send the full URL again.
  • Speech-enhanced push ingests show their connection details once. The response that first creates the captioning service, and a rotation, return the push URL (and the RTMP stream key) with credentialHidden: false. Later reads keep the RTMP server URL but omit the key; for SRT they return only scheme and host. POST /v2/ingests/{id}/rotate-key issues new details while the engines using the ingest are stopped.

Draft until the Live API release that introduces these behaviors is scheduled.

Test plan

  • Prettier and mdxlint on the changed pages
  • Merge together with the Live API release

Generated with Devin

erikdeweerdt and others added 3 commits November 17, 2026 09:27
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Generated with [Devin](https://devin.ai)
Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@theoplayer-bot

Copy link
Copy Markdown
Contributor
Documentation preview
🚀 View preview at
https://docs-preview.optiview.dolby.com/pr-982/

Deployed from commit 9d98da9 at 2026-11-17 10:20 UTC.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant