diff options
| -rw-r--r-- | doc/api/index.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/index.html b/doc/api/index.html index 40da4c3e0..857581095 100644 --- a/doc/api/index.html +++ b/doc/api/index.html @@ -475,7 +475,7 @@ data-styled.g140[id="sc-amkrK"]{content:"icZuVc,"}/*!sc*/ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor"></path></g></svg></div></div><div class="sc-kizEQm eWToXe api-content"><div class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ api-info"><h1 class="sc-fujyAs sc-fcmMJX cTueGk ikafbi">Owncast<!-- --> <span>(<!-- -->0.0.8<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="swagger.json" target="_blank" class="sc-GvhzO ksfJAW">Download</a></p><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><div class="sc-bXexck ePwgUU"><div class="sc-eGJWMs hDhyRZ"><span class="sc-gsWcmt gCgqqY">Gabe Kangas<!-- -->:<!-- --> <a href="mailto:gabek@real-ity.com">gabek@real-ity.com</a></span> <span class="sc-gsWcmt gCgqqY">URL: <a href="http://owncast.online">http://owncast.online</a></span> <!-- --> </div></div></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-summary"></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-description"><p>Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch.</p> + " fill="currentColor"></path></g></svg></div></div><div class="sc-kizEQm eWToXe api-content"><div class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ api-info"><h1 class="sc-fujyAs sc-fcmMJX cTueGk ikafbi">Owncast<!-- --> <span>(<!-- -->0.0.9<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="swagger.json" target="_blank" class="sc-GvhzO ksfJAW">Download</a></p><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><div class="sc-bXexck ePwgUU"><div class="sc-eGJWMs hDhyRZ"><span class="sc-gsWcmt gCgqqY">Gabe Kangas<!-- -->:<!-- --> <a href="mailto:gabek@real-ity.com">gabek@real-ity.com</a></span> <span class="sc-gsWcmt gCgqqY">URL: <a href="http://owncast.online">http://owncast.online</a></span> <!-- --> </div></div></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-summary"></div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy" data-role="redoc-description"><p>Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch.</p> </div></div></div></div><div id="section/Authentication" data-section-id="section/Authentication" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h1 class="sc-fujyAs cTueGk"><a class="sc-crzoAE iUxAWq" href="#section/Authentication" aria-label="section/Authentication"></a>Authentication</h1></div></div><div id="section/Authentication/AdminBasicAuth" data-section-id="section/Authentication/AdminBasicAuth" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#section/Authentication/AdminBasicAuth" aria-label="section/Authentication/AdminBasicAuth"></a>AdminBasicAuth</h2><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>The username for admin basic auth is <code>admin</code> and the password is the stream key.</p> </div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><table class="security-details"><tbody><tr><th> Security Scheme Type </th><td> <!-- -->HTTP<!-- --> </td></tr><tr><th> HTTP Authorization Scheme </th><td> <!-- -->basic<!-- --> </td></tr></tbody></table></div></div></div></div><div id="section/Authentication/AccessToken" data-section-id="section/Authentication/AccessToken" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#section/Authentication/AccessToken" aria-label="section/Authentication/AccessToken"></a>AccessToken</h2><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>3rd party integration auth where a service user must provide an access token.</p> </div><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><table class="security-details"><tbody><tr><th> Security Scheme Type </th><td> <!-- -->HTTP<!-- --> </td></tr><tr><th> HTTP Authorization Scheme </th><td> <!-- -->bearer<!-- --> </td></tr></tbody></table></div></div></div></div><div id="section/Authentication/UserToken" data-section-id="section/Authentication/UserToken" class="sc-eCApnc fxZJZV"><div class="sc-iCoGMd KWWXd"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#section/Authentication/UserToken" aria-label="section/Authentication/UserToken"></a>UserToken</h2><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>3rd party integration auth where a service user must provide an access token.</p> @@ -613,7 +613,7 @@ data-styled.g140[id="sc-amkrK"]{content:"icZuVc,"}/*!sc*/ </div></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"></span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-168" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-169" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-169" aria-labelledby="react-tabs-168"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"lastConnectTime"</span>: <span class="token string">"2020-10-03T21:36:22-05:00"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastDisconnectTime"</span>: <span class="token keyword">null</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"online"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"overallMaxViewerCount"</span>: <span class="token number">420</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sessionMaxViewerCount"</span>: <span class="token number">12</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"viewerCount"</span>: <span class="token number">7</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Server/paths/~1api~1yp/get" data-section-id="tag/Server/paths/~1api~1yp/get" class="sc-eCApnc bJnWIW"><div class="sc-iCoGMd sc-irKDMX KWWXd kBgcMI"><div class="sc-hKFxyN egQuEZ"><h2 class="sc-pNWdM euRMgx"><a class="sc-crzoAE iUxAWq" href="#tag/Server/paths/~1api~1yp/get" aria-label="tag/Server/paths/~1api~1yp/get"></a>Yellow Pages Information<!-- --> </h2><div class="sc-kYPZxB jdCbTS"><button class="sc-dWBRfb bMYkBl"><span type="get" class="sc-jHcXXw cAOCuf http-verb get">get</span><span class="sc-xGAEC jRjoAh">/api/yp</span><svg class="sc-dIsUp iFYrlT" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-bQCEYZ gBwOdz"><div class="sc-fXgAZx fKFAhr"><div class="sc-iBzEeX sc-cOifOu dFWqin cJyzuM"></div><div tabindex="0" role="button"><div class="sc-EZqKI gjiGnZ"><span></span>/api/yp</div></div></div></div></div><div class="sc-eWnToP eUdCtG"><div class="sc-iBzEeX sc-cOifOu dFWqin bHzJuy"><p>Information to be used in the Yellow Pages service, a global directory of Owncast servers.</p> </div></div><div><h3 class="sc-dTSzeu efuQZt">Responses</h3><div><button class="sc-jXcxbT bCvCHz"><svg class="sc-dIsUp jLtOTj" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-jlZJtj jSPrUM">200<!-- --> </strong><span class="sc-Arkif dXjyFC"></span></button></div></div></div><div class="sc-jSFjdj sc-gKAaRy hsSsLr gcushC"><div><h3 class="sc-kEqXSa iXmHCl"> <!-- -->Response samples<!-- --> </h3><div class="sc-carFqZ evYMTo" data-tabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="react-tabs-170" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-171" tabindex="0">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-171" aria-labelledby="react-tabs-170"><div><div class="sc-hhIiOg lhdonw"><span class="sc-oeezt bmwRob">Content type</span><div class="sc-eJocfa jzRrfm">application/json</div></div><div class="sc-gGLxEB hINeXe"><div class="sc-iNiQyp cVHUjN"><div class="sc-efHYUO eQQUSD"><button><div class="sc-khIgEk llGFDD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iBzEeX dFWqin sc-jffHpj fqzhkP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"description"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"logo"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"nsfw"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"tags"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"online"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"viewerCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"overallMaxViewerCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"sessionMaxViewerCount"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastConnectTime"</span>: <span class="token string">"2019-08-24T14:15:22Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-cKRKFl gBTuHc"></div></div></div> <script> - const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.1","info":{"title":"Owncast","description":"Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch.\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->","version":"0.0.8","contact":{"name":"Gabe Kangas","email":"gabek@real-ity.com","url":"http://owncast.online"},"x-logo":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAEvmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNS41LjAiPgogPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iCiAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgIHhtbG5zOnBob3Rvc2hvcD0iaHR0cDovL25zLmFkb2JlLmNvbS9waG90b3Nob3AvMS4wLyIKICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIgogICAgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIKICAgZXhpZjpQaXhlbFhEaW1lbnNpb249IjEyOCIKICAgZXhpZjpQaXhlbFlEaW1lbnNpb249IjEyOCIKICAgZXhpZjpDb2xvclNwYWNlPSIxIgogICB0aWZmOkltYWdlV2lkdGg9IjEyOCIKICAgdGlmZjpJbWFnZUxlbmd0aD0iMTI4IgogICB0aWZmOlJlc29sdXRpb25Vbml0PSIyIgogICB0aWZmOlhSZXNvbHV0aW9uPSI5Ni4wIgogICB0aWZmOllSZXNvbHV0aW9uPSI5Ni4wIgogICBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIgogICBwaG90b3Nob3A6SUNDUHJvZmlsZT0ic1JHQiBJRUM2MTk2Ni0yLjEiCiAgIHhtcDpNb2RpZnlEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIgogICB4bXA6TWV0YWRhdGFEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIj4KICAgPHhtcE1NOkhpc3Rvcnk+CiAgICA8cmRmOlNlcT4KICAgICA8cmRmOmxpCiAgICAgIHN0RXZ0OmFjdGlvbj0icHJvZHVjZWQiCiAgICAgIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFmZmluaXR5IERlc2lnbmVyIChNYXIgMzEgMjAyMCkiCiAgICAgIHN0RXZ0OndoZW49IjIwMjAtMDYtMThUMDA6NDY6MTItMDc6MDAiLz4KICAgIDwvcmRmOlNlcT4KICAgPC94bXBNTTpIaXN0b3J5PgogIDwvcmRmOkRlc2NyaXB0aW9uPgogPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KPD94cGFja2V0IGVuZD0iciI/Pn6jclUAAAGCaUNDUHNSR0IgSUVDNjE5NjYtMi4xAAAokXWRzytEURTHPzODESPCwsLipWE15EdNbJSZNNSkaYwy2Mw880PNj9d7I8lW2SpKbPxa8BewVdZKESlZWVgTG/ScZ6Zmkjm3c8/nfu89p3vPBXsko2aNmn7I5gp6OOBTZqNzivOZOlpx0oESUw1tLBQKUtU+7rBZ8abXqlX93L/WuJgwVLDVC4+qml4QnhAOrhQ0i7eF29V0bFH4VNijywWFby09XuQXi1NF/rJYj4T9YG8RVlIVHK9gNa1nheXluLOZZbV0H+slrkRuZlpil3gnBmEC+FCYZBw/XgYYkdlLL4P0yYoq+f2/+VPkJVeVWWMVnSVSpCngEXVZqickJkVPyMiwavX/b1+N5NBgsbrLB7VPpvnWDc4t+N40zc9D0/w+AscjXOTK+fkDGH4XfbOsufeheR3OLstafAfON6DjQYvpsV/JIW5PJuH1BJqi0HYNDfPFnpX2Ob6HyJp81RXs7kGPnG9e+AEyv2fOZnRq6wAAAAlwSFlzAAAOxAAADsQBlSsOGwAAHBpJREFUeJztfXl8VEW69vO852QhYYcAIRsGRETZ3BURRXGcn5/bOKPOOPPduRevv9EZh3tdRp1x+bjM6FXGXcdt3HGDO7ij1w0XRnHBBTAoypJASEjYlyzdp+r9/ugEmqQ7fbrTnaQDz+9XhD6n6q23u556q+qtDdiP/diPfRfsbAU6Gx/fpz36ZeJiUM8EMAzEAADZADIBGADbAdRCdbW1mFdXL88eMZ07O1PnZGKfJcA395sCOJgmgisB9vKbThXbVfF3Nfr4oZc4S1OpY0dgnyPAkpuV2sc7WRx5kURuO0RZazDLqN444VK3MWkKdjD2KQJ8ebe6jmsegMNfAshKgkhVq8uMxRmH/dYtT4K8Dsc+Q4DF93m9BXyIDs5PunBFuXp69oTL3K+SLjvF2CcI8Pm9XhbJJ0mcl8JsKuxOjD/iD86WFOaRdLidrUBHQIFZUJynmtJsitEDLwKYnNJckoxubwE+uSt4CYX3ApAOyM5aq78/ZnrGfR2QV1LQrQnw/h1eYabgGxK9OzDbOmtQeNx/umnRFHTbJuDD24MZQl1glb2RWtPfEjmATgPw1w7NNUF0hFnsFFiLi6xyuFWgwwN4w/uzgh1pdRJGt7QA784yBaC5z2qnNXG9VDgBwPudlL9vdEsCKM1lBmQHm/69dVA7FfsJ0PF4878bR1rldHZi4QOAgqcDuK5ztYiNbtcHUPLfVTXbqqKTw9hXbmzo2dm/Ryx0Kwsw50Z1rQYv7mw9miDM5kgAX3S2Im2hWxGgR3bwcgPt6GFfVKjaodhPgI6DVf1FZ+sQDlUO6GwdYqHbEGDOH+0gq8ExXaX2A4CiQz2QCaHbEAAZjXdZZRfr1GqXd7V3CwI886eGbHVxqulsRVpCaTtbhVjoFgQIKAZkqfbpSuYfAAit62wdYqFbEMDJ0EuMwulsPVpB0eVXD6c9Ae6+fHumAX6TqOfPGsAYQA1grUIt0HLhCAlQQkGEEAdwHPiYTNcNiWnVcUh7AuTkOMUWOqAt868aKmhrgWCjorEOCDQogoFQwScEAhlZQFY2kdkDyOxBiADihAgDANagKkHpHYa0J4ASw02kwlegfqdi145QQTcToBXaMW4wAaAhoMB2gNCQhXCAzCwgpxdMrpO1JnHpHYO0J4BRPaX5/8FGoKFO0VAfquGt1gCmelCmADwg4AE7d7Lsz89mBFKcY7uR9gQIGJwaaFDs2KoIdvT2jDYJZRd1lBrtQVoT4PLzt/WrWqdjdtd0n+ZcFQECj0J1IYB6BU6h8NcAeiRLN1V8lCxZqURaE0AcHGKgjMO0e7CYoca5f9ZzuZvCns+74hfbb3Cov4TwLwBy2qubiv2uvTI6AmlNABWMtv4Lvw5WfvPXp3s+Fenlbc/03gjgzssv3L5IHLyDdpBAQ/+sSjR9R6KL+c7jgzp6iKXCT/BUb/zr7MiFH47bn+69yBhztqWqX9kRwne3ze7b5X0AQJpbAAMe6Mv8q75sa/vc7luu4D1C14EsSkgxq7MSStcJSGsLYEVHKENzbtGCJRqt8vp73vA/MXP3U/2Clrg3luwoIaiC11L5vZOJtCXA+ecZscQBhoq2goU+cM+TfZbEK7+xUR6OJTtK2GVpN6fiO6cCaUuAXjnbhlvCtaFaHj2oPpKI/Iee7b3FEttjym8ZgAfufax/l3cANSNt+wB0dKSNMQOkiiWeeN8kmoel7kJ8q3oaxGTdkmh+nYG0JQDIEbGGgAr5/aOP5CW8KCOOIWYzvnnw8ZytiebXGUhbAnjUIrZRQATqAPN1e/Iw0Ky45g+Us9uTX2cgYQLMuP760szMzCtF5DQSRQTqAXwL1QVq7Wu7Nm7654y77krZKi0Fh7ZVOBZYr3C3Jyr/Zz+rcFXg+/QwADX0vIcSza+zkBAB/uuGG452MtyPFBCrFlSAQC+SRxI4UkT+0HPgwA9uufHGaXXAyhkzZiR9sZY66N+WUGv10ace6p2w+c/s13OsJTL8xrdq5zz1aF6XXwLWEnGPAq675pphCsw3nhFjPBjPgzEmFDwPxoQ+q9oT6MrXOYInZv7pT0lvagw1q42hmEqCvf9mkHpWPMM/haZd7QcSGQaKzDTW9je2qdCN3UOA8M/WwBqTA8WvMjOcT278w+Xjkqm4JbLbGI7VPPHwwJpEZZ9/8QZaB+f6H/rp/8x+MC8tD42MiwBXTp9eZK29wDYVtm1Z+DYCGaxBY2PjYW+9+uqno4fknZYsxS01sw1f/Pr2yFbX6WGphf59//TtZu5qiM8CuO7vjTFuyPQbeGaPyW/ZBBjPwBgPwUAAr7/4IrZt3ZopIi+MyR/0n8lQ3AJOtBppoJXtkq1abInefmq/Ib60MJ8m4zt1BuJqm9XaiQYKi9AUPImmv02fm/4vCH1Qa/HJwg+xdesWCAES2SRvHjt0cG6Q5qbllRsTH6OLRiWvEu0yx9bFzT539XgW+PW8vw3qcntS/CIuC2CMKQiZfgNrm9t7G/psDKzd0/4bz2BFWRkqVq9uKSZLhDOyIf8+bmhewmv5TdttcsIEOOeyjUNAnO2r9gPLgsYm7GnsCojLAhhrB9GGvjzB3RZAEfoPAQhDn6vXV+KrxYujDdWFIve7BvUAnkxEcQVstDpqIAmvxjGik33WikBjUH70+v15aVv7gTgIMG3atJ7GmOw9pj+MAGFNgJIINDTgy88/g6qiDW8d4fDhIwoH13++bsPceBU3olGbDxOUNfHKA4DJ01dnKO0M48f9p/ri6/fnJTzS6Crw3QRYa3vtHvM3dfBCf1t2/jx89ski1O3aFVMmgUyKPHRkweC4h4hKBKLM/wfn/21AQtOxucw5Q8mDfKwx2OxRktKZ7Wz4tgCe57kOuafD12QFQiYfAAEBUbm2AjXV1RCfPnQCfek6LwMoiUdxQwSjvNoWj5xwWOF0Xy5LxazX78xr11Czq8A3Aay1QWNtq8K3CBU8CTQGGrH064ROTC8+piT/HevZH31aucHzpQ+j7rytT0SBqVds+IlCj49JAMXXVu09ieTRFeG7CQgGgzt3m/qmJsDzQr1/Yzx4wSC++uILeF6o/Kzq6xb2/1iDCap6iaq+D0XUwiV4kuM4F/nVxxCbI4/LNZplaBMKvcESEqPnr0Hg0rfuzI/dvqUJfBNgzpw5Oz1j6vf29O0JmzZtRG1NqE9kVZesrNl0+g8bNr22orb2q2+rax8oq6o90RhzLlSj1VCK8P6JJflj/OhjoWsjeeWU8W8TP/HKDRepYFwsj5+Bvf3d2wenxYYPv4jXD1DVsuA9YxAMevhm6bLd8aj4I9B6v27Zho0vq9XRsPpxtDwIzj5+yJDsmLoQK6J45mKmDcfkq6p6QnRW7DG/VnvGuzEe2emA+AjgeT/scfuGTL81HirXrUVd3R6raKFRnSNLq2vXKOxJanUuIpCEwrHMdq6MpYvSLI9cWOp7CdfxV1ZnqvBxJfq2TQDd4VFP/eCOom5j+psRFwE8z3ve2z3xE5oMCgYNKsrL945ndFMUEQCAr9fXNn5ZueE8QF+O1Okied3xxYPaXJMfCJqvDNVGaAJ6HHVlua/j2dTV05V6bgzTrwZ618Jbh6blbF8sxGcBNPCM8czG8MmgtRXlaGjYu1kX8Xz5+NUGfwHV+S2fk8hynYy/t5V20R3FuyxRYUJmf68grjsqVt7HXVs9ToknIqVvEV60NjjDz/dJR8RFgFdeeaPBGPN8+BqADdXVreIRbn8/8hZXbqpTi4ugWtZaCKecOKzg+LbSW+pSpaJVEBzdVrojr1k3wNI+qtReEdPvCd9bay/7aFaJr6FpOiLuBSEWuMcYEzDGYNPGja1qPwA4Igf5lfd5ZXWVVVwAoOVaepfCZycXF0RdlmVgv4pUaxU6JVqasddWZUI4xxKHxaj5DR5w/qJbCto1tdzVETcB5s+f/50x3i3GeChfsyZiHAUuj0fmrgZvmar9OVp0CkkOFdojoqUzlE8jttvCiEPJCddXu5mOma+Ck2K0+8ajPb2xkWl3D2C8SGhnkDXm3vr6hppgMLLPheRppXn9f+RXXlltrRJ4RVtfsCDiOk+cUloY8ZZPemaRJTwrQItQNO66ymnhccdct7YY8F615MlWwAhpQoEIWuAKbTQLltyW38VOHkw+fHrsW6Mgb+ARxpiPhXClaX5AGHIPCwhCyxT2uJU1W3z75o8v7tMTTs8Kh+wXLk+tTnxn1bqIDpjxN1TOB/DjCK8aLexPAZQTPAHAzYx9SbSB4o6vZhZc5VfndEfCewMDgeBiVXtrtPckRwuc/4lH5sKKbTth7QMtnwtwabQ0Ru1DUcx4FsiXQX6hoZ2+vWKeIQDcErTe1fHonO5I2AI0I79/32cdkQtaWgAJTRgpYF8EcMGKDZt8bZg8tiS/Z4bIUiGHNcsjEFTPlry9prLVuXsHX792sDhYHzrGsR1Q/ZNCby2bUdxte/yR0O7dwVWbt/5SVV+N8ppCOUfI90YN6e9ruvfj8qqdqnhsLyFghrgSsU+xfGbRBqO4ox2neTQY6mXfzCi6aV8rfCA528NN0LPnQDXqoQikHCt0lx88ZGDU4dle8Y3OaS2DJ0WLbwUzLbEz7q3cxE7jmaO+vbHoXn9ftfshKecD1Gzb5sHi59bqfYjg3wcAEj0cceaPHTro6dFD8wrbkkdZ/x20xdJu1ajDwRU3Fm0zVn9rqcaKwk8w0LcscPiKmcO6pYvXL9rdBwhHSZ8+ggznekfkKofIbV40wua+QfNoAWgEcStUnwsE9Nuy2tq9XMcjRoAFpuA7R+TA3aMKImDMjty3V22JaqZLZ5bPIvkfaHuhS7kC9+4Ibr+zdsah+5zJb4mkEqAZJQP6jMlwMhYIOSAiAfYeLi4B7UyHzosE1AktI73IdeT+veIR8BqR/05FRWvfcxiGzSz/FQWPAHTDvp8FsNNac0PAy7ynakZBl7/IoaOQEgIAQOmg/vkO5GpHOL0tAuwmCFBPcqsAmUL2F4KtCBAMDnlnTVXM49eKbyofBIuRJAcpdCeAalpZVX59UZc/v7+jkTICNGPk4AFTHcp1IpwopNMGAfY8j2QpiJ1rv6/oWwak9Tr8roaUnxCyYsOmtwC8dfCQgWeIyL0gC4D4l22p6oKuXvhHH3W8S6Hr0HFE6IAUUsR4nus4zKLQccTxHMmoB6lCGhFaKDwReq/978sJrWdsD1JuAcJxSF7/XCfDPYrk1Y7wVAHpxwIQqKfi2DdXrm3XkS/JxoQJxw12XZ0kkKNBjnFEBlPYk5QeBHIokiVkBikZoWaQQOivJcUj2UiygeROEdkBYLOAnynxgQYC77369qspb7I6lADhGJ8/aJQIz3ZEThBynBBDIxDAI7CQ1l759urKxZ2lKwCMHTs+B3CPEPJIER4rIkeRLCIJEQEQKmAKQUp4YYMUtCBA6JkQ0uTAFAnFCcUTgAwIuBjCBSQXBAONH708f17STyDpNAK0xPghgwf3yJIjHCAfBBxwvbG7PlxYsW1HZ+l08MFje4lghFAuofDfRBwnVDiAMKzAUkOApngERUBgE4DrhM7c5+c91eaSu3jQZQjQlVBaOmJAVlaPW0XkVJJDhHQpElY4HU8AIUN5CGuVfEGN9/s5855p9xUZ+wkQhgMPPHiSiFwqIj8l6Yo0/ejNtbBrEKBZ3kpVXP3s3Mf/0Z7vvJ8AAIYPP6hABLeIOBcyvMC6NgEgJBR6k1r9r2fmPpGQNUjbs4KThQNKR5wnwmWkXNjZuiQCUq5xXOe5hNMnU5l0wrBhw3pQ3Fki8tvw2pxuFqApnoJ8UI3+7qnnH4nLV5K2R8W2ByUlJQ7o3E3S92bUJmxT1c0kdwLYpaF9jlus1QYhqERPgn0B9FDV3iQHAOiP1Fc0ErxYROYBeCuuhClSqEujuPiA/3Ac53YK2Vzj2rAAtQQeouhskYxKVQQFMBaO+frrT1pNKh04/AQOHmgFjuuKiGsMhrkZcpUjzoVCuimyAM3PGoJA/tNPP+T7wOp9kgDDDhheQbAoZK5bEwBgNcDbSLxLmmVlZWXtPv9/8uST81y4P6YjfxJyZIoIAFX91yeeefhxv3p1OAGOL+4juRm5fRXSG2CGUusCwcaa98trO8QPXlhYMsnNcD8gmtvrvQjQAPABx9GrysrKUrJWYMqU0/o4lEeF8pNUEIDkJ4/NfvAYv/p0GAGOKSzM7JWJ34GcTmlxGZOiTlWf21RXP/2Lqo0p3YFbXDzsJnGcayMRQBXXf//98j+nMn8AyMs7h+PHBN5wXDk12QQQEXjBYO6Tzz3iy22c8mHgpNL8/JOHF72Umy0bVeQ2JYutgnsFIFfJaf1yc2pOKi2cnkp9NNSBiwhr9fFU5t2M2toXlGJ/BiAll0uI6/bzHTcVCjTjhNLC0xy6Kyx5pgV6GYTmc6MFC+SAcucJpYVnpEonqnkF0dctHpKqfFvizbdf366qn6RCNkHfV+CmjAATSwqPBmW+BXsaBcKCGsUOz9gHg9abbLVxUDBgS4JqrzIKYwAoeUOq9KqoqFgKxQ+R3onI7SNHHpyZqrxbg3EN2fzD1zG3AFJIAHV4s1GwReHXG7XTrLFFH65e95uFq9Z/8P7KDbULK9ZVWM/eZtR+bkJHgE44sniwbzMWL6zaiKd7kxhNyj9HjBgRz0VRCYOavMuqw6GIeoReK6SEAEcXDB5qgckWivBgrPnNP1ete2zhmnWt9gt+VL5ejaK+Ka5DyJBU6AYAFeWrH1ToK5HekTjCzcheMWrUIWcedNBBCZ9l7AcKTEqNXOt7IUlKPIHWdcZTW5BL1XqN9ploaQ4rLMi04Jjm1jmg6uu+n5OGD5UMOjlUiLXB+rdWV/thv6r1/gXM/BpEq6NoCA6myEuk849DDhlzmaqpLisrS+pO4VOm/DibgsOSKRMAVDVQ18gtfuOnxAJYsK6F6YcBoW4gavtqiJFG0TcUX6sDa6tjnsQ5tbRweCbdN0gpg8hycTK/mDqi+HfwMbwtLy/fYq2eAEXUH4vkuaRT5jqZz4wePdrXqSd+QcrZAHydZRQf9M25cx/yPR+QEgI02MBio1pnEVqQ3xTESvb5keKPKy7oR+E8CzgWgFG8Wxalp96MU4YXn0xHPgI5FUARgKEgDxXynqkjij+ZOrzoyFh6rlnzwxprvUNUta2rZfsCvCDD7VE5btzhj40be8TUUaMOb1dH8ZQppx0t5ONIgR9GVZ+NJ37KHEFjigtfIHl2+DMFak3QO6ZsfdWq5meji/L7OHQeIXnu7niqZyytWBdtwylOHl7QW8RdAWBwGyoEDLypYuzCt1dVxdoIwgNHjnpTKFMYWskbazZwPYDbSHlJgE0Wsn3x4o9ibjaZMnlqH4pzloj8XSgZKfAEehYsefLpB32fY5wyAowuHjqZlPcivNqsaq8NqPdmJt0TAP4/kgc0v1TVD9TTk5evXx/RFXt8cTGzMvE+ST8dqACs/fnbK9fOixWxdOTILEedSx1Hbo9jOjhAcgvADUK+Q2KhUpYaU1/+2WefBUaPHi0Dew4cqllZx2Q4PI+USSQHSTPJkkwAqM564tm//8HH77IbKXUFH1RUcDfJy/zGV8Cq2sNXrF0f9Wyek4YVFjHD+QGAXzPcoKo/XfBDha8r3UeOPPhYx3FvI3lse9YDEDAUkdCEY8rXAwBkgzW2ePbzj9b6/F1C+cYTOV4EPXudtfqtVcBHMNbaS9sqfACAw2uhyIQCYaHOGnMmgma4qs6DQsPeZQN4YtKwolI/Oq9YsfzjYNBMUtU/qyKuHzMcJB103FyLVcXMeAsfSDEBVlVVbQ9anRi0ujGGG1iN2msUaPPyxRNKhuQq5eIWnUtYY65+b9W6V95ds26VWj3fWntH+HsFBziuvORX7x9+KDPLly+93lp7IBK80qYjodCFDd62mxNJm1JHBwBs3bGjvmdu7pMgBqniUAVlr8qrusJanba6cv1jm7e3vQWgeEC/g0m2PC+ounbV2p/XNo0a1mzZbov69fqIkB+BGBoWb1BJ395Dh/TNnl+5dZevMf3GjTWNNTXVL+UNyn+ZpENwDEkHTbuZWqwhaP2MPp8hgryI8SI++1SVZz43Z3ZCm0Y6dD1AQX7+UUL+K8hSBTZD9TXP2rnV1dW+VrROHF50jkPZq0Oniv/9cGV5qwspJxUXDGGmuwrYy90atNYcvnDVuoQOhRgz5vBhjsOZInKyUPI7e00gycXGBs98bu7shG8v6dA1gZVVVZ8CSPiSRSEPa1l1VfX9SHE/rKisnlha9DcRuSLscQYobx+en1+0uKoq7lU+S5cuXgPgV2PHTMh03Yx/EZE7SebEKycpUPtqQ9D52T9emN3QHjFptSzcWoxq1XkkonYa6fFaq1gbHl/BQZk93Avao8eSpV8Gvvjy04cDwfp+UExS1f8GUNEemX6hinJr7E+M1XP+8cJj7Sp8IM3WBB5XWryI5F4HQRuYCYtWrotKguNKi/9C8o/hzxSo9Iwd/ematb7mG/xg7NixTm5278kUOUtEDid5IEXykjQMDArwlSqfrwvqfa+99ky7C74ZabUs3AK9WzLWeLbNH6MRO/6Sob0uJxl+k0iBkL8GcHeydFuyZIkB8G5TAABMOu6kA63wQhGcTjpjEOp0s0VoCUXTAEZVN1H1vu317l1vvjk7JZtk08oCHF1a/D3JEeHPVM1hn6xa92WMdLNJ7r3zR1G2aFV5h60AmjJxSg91M/o5In0p7EUwh8IsQnoISQo9gg10WC+QLQBqGs3O2jfeeCOl5xWnlQVQoNWCUVUUAWiTAKp4GcTeBCBGH3lA0VmfrV7r2z/QHrz7z3frEbrSrkvdN5henUBgSysnEGR8zHTWe88C2jItyG5x+2d7kFYEUMVKVSA8gJwYK93n5etr1OqylmkVHI80awaTjfQiALBs7ykAQIFD/aS10M8ipO1z2LDCX6dI3bRAdyDA0HHDin4ROy3XR0gLpVwxqmDQPmsF0ooAVrGmdR8AoMhd4w8o6tlmWiA7UlolizPdrNzUat51kV4EgFehQE2EmjzQgnMPKS7sGyUpAZwY0QIAORb+L5vsbkj5bGAyUbN1hxnUp48FGOHuAI6gyKl5fXovzuvdZ0vt9u0eAJSUlLCwX++zSIl2kZWo8r2abdtWpFD1Lou0a/tGFxcNcBxZC0TdVBGAosaqLiBZDegxJI8Eot8prNb+dVn52n3mnqBwpJUjCADE2C2GfJfC06NEyQRRCPJXIRca215eDADk2GTqmE5Iqz4AACyrrLRBY/+vAr5vI4sFBfKSJSvdkHYEAIDv163bbI3eE6lXn1BQ/3vpuhvSkgAAUAfMsKovtvLuJRBAfNvZ36ezkLYEqKio8Dwb/DdrdVGU4Z3v4FlE3Ci6LyBtCQAAKyuqtjQAJ1qri9tBgEYC73WC+l0CaU0AAKioqGisa2g41lh7mQV2xtv+G7XzPGs3d472nY+0cgRFw45du+yWbds/7ZPbcy6FOUrmA4h1TzCgusCDnLtm7doufRNJKpF2jiA/GNG/v2tzcs5Tx7maZClC/o5msltVbYDqTasrKqLefbyvoFsSIBwlBQWOuK6rqkIAULVBY4Lr1q/ff3XcfuzH/wfoPFiLyqlaYQAAAABJRU5ErkJggg=="}},"servers":[],"tags":[{"name":"Admin","description":"Admin operations requiring authentication."},{"name":"Chat","description":"Endpoints related to the chat interface."},{"name":"Integrations","description":"APIs built to allow 3rd parties to interact with an Owncast server."}],"components":{"schemas":{"ClientArray":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"UserArray":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"LogEntryArray":{"type":"array","items":{"$ref":"#/components/schemas/LogEntry"}},"Client":{"type":"object","description":"A single representation of a client.","example":{"connectedAt":"2020-10-06T23:20:44.588649-07:00","messageCount":0,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36","ipAddress":"::1","clientID":"2ba20dd34f911c198df3218ddc64c740","geo":{"countryCode":"US","regionName":"California","timeZone":"America/Los_Angeles"}},"properties":{"connectedAt":{"type":"string","format":"date-time"},"messageCount":{"description":"Number of chat messages sent by user","type":"integer"},"userAgent":{"description":"The web client used to connect to this server","type":"string","example":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"},"ipAddress":{"description":"The public IP address of this client","type":"string"},"clientID":{"description":"The value used to identify this client","type":"string"},"geo":{"type":"object","description":"Optional geographic data for the client","properties":{"countryCode":{"type":"string"},"regionName":{"type":"string"},"timeZone":{"type":"string"}}},"user":{"$ref":"#/components/schemas/User"}},"x-last-modified":1602052347511},"BasicResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"InstanceDetails":{"type":"object","description":"User-facing details about this server.","properties":{"name":{"type":"string","description":"Displayed as the header in the instance details."},"summary":{"type":"string","description":"This is brief summary of whom you are or what the stream is."},"logo":{"type":"string","description":"Local file name of your logo image. We recommend a square image (150 x 150px) with ample padding around the important contents of the image, as it will be rendered as a circle."},"tags":{"type":"array","description":"Categories of the content this instance focuses on.","items":{"type":"string"}},"socialHandles":{"type":"array","description":"Links to social network urls.","items":{"type":"object","properties":{"platform":{"type":"string","example":"github"},"url":{"type":"string","example":"http://github.com/owncast/owncast"}}}},"extraPageContent":{"type":"string","description":"Additional HTML content to render in the body of the web interface.","example":"<p>This page is <strong>super</strong> cool!"},"version":{"type":"string","example":"Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"}}},"YP":{"type":"object","description":"Configuration of the instance's registration to the Owncast Directory (YP API)","properties":{"enabled":{"type":"boolean","description":"If YP support is on or off. Must be enabled to show in the directory.","default":false},"instanceUrl":{"type":"string","description":"The public URL of this owncast server, used for registration and linking with the directory. Must be publicly available."}}},"S3":{"type":"object","description":"Configuration of external storage using S3-compatible providers.","properties":{"enabled":{"type":"boolean"},"endpoint":{"type":"string"},"servingEndpoint":{"type":"string"},"accessKey":{"type":"string"},"secret":{"type":"string"},"bucket":{"type":"string"},"region":{"type":"string"},"acl":{"type":"string"}},"required":["enabled"]},"StreamQuality":{"type":"object","properties":{"videoPassthrough":{"type":"boolean","description":"If enabled video transcoding is disabled and the video is passed along in its original format."},"audioPassthrough":{"type":"boolean","description":"If enabled audio transcoding is disabled and the audio is passed along in its original format."},"videoBitrate":{"type":"integer","description":"The video quality, in kbps."},"audioBitrate":{"type":"integer","description":"The audio quality, in kbps."},"scaledWidth":{"type":"integer","description":"The resized video width."},"scaledHeight":{"type":"integer","description":"The resized video height."},"framerate":{"type":"integer","description":"The target frames per second of the video."},"cpuUsageLevel":{"type":"integer","description":"The amount of hardware utilization selected for this HLS variant."}}},"TimestampedValue":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"value":{"type":"integer"}}},"ConfigValue":{"description":"A wrapper object used to set values in many config endpoints.","type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"boolean"}]}}},"LogEntry":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"Timestamp for this log entry"},"level":{"type":"string","description":"The level of this log entry"},"message":{"type":"string","description":"The log entry contents"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this webhook."},"url":{"type":"string","description":"The URL that events will be sent to."},"events":{"type":"array","items":{"type":"string","description":"The events that will be sent to this webhook."}},"timestamp":{"type":"string","format":"date-time","description":"When this webhook was created."},"lastUsed":{"type":"string","format":"date-time","description":"When this webhook was last used."}}},"User":{"type":"object","properties":{"id":{"type":"string","description":"User ID","example":"yklw5Imng"},"displayName":{"type":"string","description":"The user-facing disaplay name for this user.","example":"awesome-pizza"},"displayColor":{"type":"integer","description":"Hue value for displaying in the UI.","example":42},"createdAt":{"type":"string","format":"date-time","description":"When this account was originally registered/created."},"previousNames":{"type":"string","description":"Comma separated list of names previously used by this user.","example":"awesome-pizza,user42"}}}},"securitySchemes":{"AdminBasicAuth":{"type":"http","scheme":"basic","description":"The username for admin basic auth is `admin` and the password is the stream key."},"AccessToken":{"type":"http","scheme":"bearer","description":"3rd party integration auth where a service user must provide an access token."},"UserToken":{"type":"apiKey","name":"accessToken","in":"query","description":"3rd party integration auth where a service user must provide an access token."}},"responses":{"UsersResponse":{"description":"A collection of users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserArray"}}}},"ClientsResponse":{"description":"Successful response of an array of clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientArray"},"example":[{"connectedAt":"2020-10-06T23:20:44.588649-07:00","messageCount":3,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36","ipAddress":"172.217.164.110","geo":{"countryCode":"US","regionName":"California","timeZone":"America/Los_Angeles"},"user":{"id":"yklw5Imng","displayName":"awesome-pizza","displayColor":42,"createdAt":"2021-07-08T20:21:25.303402404-07:00","previousNames":"awesome-pizza,coolPerson23"}}]}}},"LogsResponse":{"description":"Response of server log entries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogEntryArray"},"examples":{"success":{"summary":"Logs returned","value":[{"message":"Owncast v0.0.0-localdev (unknown)","level":"info","time":"2020-10-29T18:35:34.422386-07:00"},{"message":"Web server running on port: 8080","level":"info","time":"2020-10-29T18:35:35.011731-07:00"},{"message":"RTMP server is listening for incoming stream on port: 1935","level":"info","time":"2020-10-29T18:35:35.011823-07:00"}]}}}}},"BasicResponse":{"description":"Operation Success/Failure Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicResponse"},"examples":{"success":{"summary":"Operation succeeded.","value":{"success":true,"message":"context specific success message"}},"failure":{"summary":"Operation failed.","value":{"success":false,"message":"context specific failure message"}}}}}}}},"paths":{"/api/config":{"get":{"summary":"Information","description":"The client configuration. Information useful for the user interface.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceDetails"}}}}}}},"/api/ping":{"get":{"summary":"Mark the current viewer as active.","description":"For tracking viewer count, periodically hit the ping endpoint.","tags":["Server"],"responses":{"200":{"description":"Successful ping"}}}},"/api/status":{"get":{"summary":"Current Status","description":"This endpoint is used to discover when a server is broadcasting, the number of active viewers as well as other useful information for updating the user interface.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"lastConnectTime":{"type":"string","nullable":true,"format":"date-time"},"overallMaxViewerCount":{"type":"integer"},"sessionMaxViewerCount":{"type":"integer"},"online":{"type":"boolean"},"viewerCount":{"type":"integer"},"lastDisconnectTime":{"type":"string","nullable":true,"format":"date-time"}}},"examples":{"online":{"value":{"lastConnectTime":"2020-10-03T21:36:22-05:00","lastDisconnectTime":null,"online":true,"overallMaxViewerCount":420,"sessionMaxViewerCount":12,"viewerCount":7}}}}}}}}},"/api/chat/register":{"post":{"summary":"Register a chat user","description":"Register a user that returns an access token for accessing chat.","tags":["Chat"],"security":[{"UserToken":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":"Optionally provide a display name you want to assign to this user when registering."}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The new user's id."},"accessToken":{"type":"string","description":"The access token used for accessing chat."},"displayName":{"type":"string","description":"The user-facing name displayed for this user."}}}}}}}}},"/api/chat":{"get":{"summary":"Chat Messages Backlog","description":"Used to get chat messages prior to connecting to the websocket.","tags":["Chat"],"security":[{"UserToken":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/yp":{"get":{"summary":"Yellow Pages Information","description":"Information to be used in the Yellow Pages service, a global directory of Owncast servers.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"logo":{"type":"string"},"nsfw":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"online":{"type":"boolean"},"viewerCount":{"type":"integer"},"overallMaxViewerCount":{"type":"integer"},"sessionMaxViewerCount":{"type":"integer"},"lastConnectTime":{"type":"string","nullable":true,"format":"date-time"}}}}}}}}},"/api/emoji":{"get":{"summary":"Get Custom Emoji","description":"Get a list of custom emoji that are supported in chat.","tags":["Chat"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Emoji"},"emoji":{"type":"string","description":"The relative path to the Emoji image file"}}}},"examples":{"default":{"value":{"items":[{"name":"nicolas_cage_party","emoji":"/img/emoji/nicolas_cage_party.gif"},{"name":"parrot","emoji":"/img/emoji/parrot.gif"}]}}}}}}}}},"/api/admin/status":{"get":{"summary":"Server status and broadcaster","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Server status and broadcaster details","content":{"application/json":{"schema":{"type":"object","properties":{"broadcaster":{"type":"object","properties":{"remoteAddr":{"type":"string"},"time":{"type":"string","format":"date-time"},"streamDetails":{"type":"object","properties":{"width":{"type":"integer"},"height":{"type":"integer"},"frameRate":{"type":"integer"},"videoBitrate":{"type":"integer"},"videoCodec":{"type":"string"},"audioBitrate":{"type":"integer"},"audioCodec":{"type":"string"},"encoder":{"type":"string"}}}}},"online":{"type":"boolean","description":"Is a stream currently active"},"viewerCount":{"type":"integer","description":"The current number of viewers"},"sessionPeakViewerCount":{"type":"integer","description":"The peak number of viewers this streaming session"},"overallPeakViewerCount":{"type":"integer","description":"The all-time peak number of viewers"},"versionNumber":{"type":"string","description":"The current version of the owncast software"}}},"examples":{"connected":{"summary":"Broadcaster Connected","value":{"broadcaster":{"remoteAddr":"172.217.164.110","time":"2020-10-06T23:20:44.588649-07:00","streamDetails":{"width":640,"height":480,"frameRate":24,"videoBitrate":1500,"videoCodec":"mp4a","audioBitrate":256,"audioCodec":"aac","encoder":"obs-output module (libobs version 25.0.8)"}},"online":true,"viewerCount":3,"overallPeakViewerCount":4,"sessionPeakViewerCount":4,"versionNumber":"0.0.3"}}}}}}}}},"/api/admin/disconnect":{"post":{"summary":"Disconnect Broadcaster","description":"Disconnect the active inbound stream, if one exists, and terminate the broadcast.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/yp/reset":{"post":{"summary":"Reset your YP registration key.","description":"Used when there is a problem with your registration to the Owncast Directory via the YP APIs. This will reset your local registration key.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/chat/clients":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/ClientsResponse"}}}},"/api/admin/users/disabled":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/UsersResponse"}}}},"/api/admin/logs":{"get":{"summary":"Return recent log entries","description":"Returns server logs.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/LogsResponse"}}}},"/api/admin/logs/warnings":{"get":{"summary":"Return recent warning and error logs.","description":"Return recent warning and error logs.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/LogsResponse"}}}},"/api/admin/serverconfig":{"get":{"summary":"Server Configuration","description":"Get the current configuration of the Owncast server.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"instanceDetails":{"$ref":"#/components/schemas/InstanceDetails"},"ffmpegPath":{"type":"string","description":"The path to the copy of ffmpeg that this server is using."},"webServerPort":{"type":"integer","description":"The port the public web server is listening on."},"rtmpServerPort":{"type":"integer","description":"The port the inbound RTMP broadcast should be sent to."},"s3":{"$ref":"#/components/schemas/S3"},"videoSettings":{"type":"object","description":"How the different variants of video streams are configured.","properties":{"videoQualityVariants":{"type":"array","items":{"$ref":"#/components/schemas/StreamQuality"}},"latencyLevel":{"type":"integer","description":"The level of latency selected for streaming. Lower latency can create more buffering."}}},"yp":{"$ref":"#/components/schemas/YP"}}}}}}}}},"/api/admin/chat/messages":{"get":{"summary":"Chat messages, unfiltered.","description":"Get a list of all chat messages with no filters applied.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/admin/chat/updatemessagevisibility":{"post":{"summary":"Update the visibility of chat messages.","description":"Pass an array of IDs you want to change the chat visibility of.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"visible":{"type":"boolean","description":"Are these messages visible."},"idArray":{"type":"array","items":{"type":"string","description":"IDs of the chat messages you wish to change the visibility of."}}}}}}},"tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/chat/users/setenabled":{"post":{"summary":"Enable or disable a single user.","description":"Enable or disable a single user. Disabling will also hide all the user's chat messages.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID to act upon.","example":"yklw5Imng"},"enabled":{"type":"boolean","description":"Set the enabled state of this user."}}}}}},"tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/config/key":{"post":{"summary":"Set the stream key.","description":"Set the stream key. Also used as the admin password.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"}}}}}},"/api/admin/config/pagecontent":{"post":{"summary":"Set the custom page content.","description":"Set the custom page content using markdown.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":"# Welcome to my cool server!<br><br>I _hope_ you enjoy it."}}}}},"/api/admin/config/streamtitle":{"post":{"summary":"Set the stream title.","description":"Set the title of the currently streaming content.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"Streaming my favorite game, Desert Bus."}}}}}},"/api/admin/config/name":{"post":{"summary":"Set the server name.","description":"Set the name associated with your server. Often is your name, username or identity.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"}}}}}},"/api/admin/config/serversummary":{"post":{"summary":"Set the server summary.","description":"Set the summary of your server's streaming content.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"The best in Desert Bus Streaming"}}}}}},"/api/admin/config/logo":{"post":{"summary":"Set the server logo.","description":"Set the logo for your server. Path is relative to webroot.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"/img/mylogo.png"}}}}}},"/api/admin/config/tags":{"post":{"summary":"Set the server tags.","description":"Set the tags displayed for your server and the categories you can show up in on the directory.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":["games","music","streaming"]}}}}}},"/api/admin/config/ffmpegpath":{"post":{"summary":"Set the ffmpeg binary path","description":"Set the path for a specific copy of ffmpeg on your system.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"/home/owncast/ffmpeg"}}}}}},"/api/admin/config/webserverport":{"post":{"summary":"Set the owncast web port.","description":"Set the port the owncast web server should listen on.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":8080}}}}}},"/api/admin/config/rtmpserverport":{"post":{"summary":"Set the inbound rtmp server port.","description":"Set the port where owncast service will listen for inbound broadcasts.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":1935}}}}}},"/api/admin/config/nsfw":{"post":{"summary":"Mark if your stream is not safe for work","description":"Mark if your stream can be consitered not safe for work. Used in different contexts, including the directory for filtering purposes.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":false}}}}}},"/api/admin/config/directoryenabled":{"post":{"summary":"Set if this server supports the Owncast directory.","description":"If set to true the server will attempt to register itself with the [Owncast Directory](https://directory.owncast.online). Off by default.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":true}}}}}},"/api/admin/config/serverurl":{"post":{"summary":"Set the public url of this owncast server.","description":"Set the public url of this owncast server. Used for the directory and optional integrations.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"https://live.mycoolserver.biz"}}}}}},"/api/admin/config/video/streamlatencylevel":{"post":{"summary":"Set the latency level for the stream.","description":"Sets the latency level that determines how much video is buffered between the server and viewer. Less latency can end up with more buffering.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The latency level","type":"integer"}},"example":{"value":4}}}}}}},"/api/admin/config/video/streamoutputvariants":{"post":{"summary":"Set the configuration of your stream output.","description":"Sets the detailed configuration for all of the stream variants you support.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":[{"framerate":30,"videoPassthrough":false,"videoBitrate":1800,"cpuUsageLevel":2,"audioPassthrough":true},{"framerate":24,"videoPassthrough":false,"videoBitrate":1000,"cpuUsageLevel":3,"audioPassthrough":true}]}}}}}},"/api/admin/config/video/codec":{"post":{"summary":"Set the video codec.","description":"Sets the specific video codec that will be used for video encoding. Some codecs will support hardware acceleration. Not all codecs will be supported for all systems.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The video codec to change to.","type":"string"}},"example":{"value":"libx264"}}}}}}},"/api/admin/config/s3":{"post":{"summary":"Set your storage configration.","description":"Sets your S3 storage provider configuration details to enable external storage.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":{"enabled":true,"endpoint":"https://s3.us-west-000.backblazeb2.com","accessKey":"e1ac500y7000500047156bd060","secret":"H8FH8eSxM2K/S42CUg5K000Tt4WY2fI","bucket":"video","region":"us-west-000"}}}}}}},"/api/admin/config/socialhandles":{"post":{"summary":"Set your social handles.","description":"Sets the external links to social networks and profiles.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":[{"platform":"github","url":"https://github.com/owncast/owncast"},{"platform":"mastodon","url":"https://mastodon.social/@gabek"}]}}}}}},"/api/admin/config/customstyles":{"post":{"summary":"Custom CSS styles to be used in the web front endpoints.","description":"Save a string containing CSS to be inserted in to the web frontend page.","tags":["Admin"],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"body { color: orange; background: black; }"}}}}}},"/api/admin/viewersOverTime":{"get":{"summary":"Viewers Over Time","description":"Get the tracked viewer count over the collected period.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"examples":{"default":{"value":[{"time":"2020-10-03T21:41:00.381996-05:00","value":50},{"time":"2020-10-03T21:42:00.381996-05:00","value":52}]}}}}}}}},"/api/admin/hardwarestats":{"get":{"summary":"Hardware Stats","description":"Get the CPU, Memory and Disk utilization levels over the collected period.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"cpu":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"memory":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"disk":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}}}},"examples":{"default":{"value":{"cpu":[{"time":"2020-10-03T21:41:00.381996-05:00","value":23},{"time":"2020-10-03T21:42:00.381996-05:00","value":27},{"time":"2020-10-03T21:43:00.381996-05:00","value":22}],"memory":[{"time":"2020-10-03T21:41:00.381996-05:00","value":65},{"time":"2020-10-03T21:42:00.381996-05:00","value":66},{"time":"2020-10-03T21:43:00.381996-05:00","value":72}],"disk":[{"time":"2020-10-03T21:41:00.381996-05:00","value":11},{"time":"2020-10-03T21:42:00.381996-05:00","value":11},{"time":"2020-10-03T21:43:00.381996-05:00","value":11}]}}}}}}}}},"/api/integrations/streamtitle":{"post":{"summary":"Set the stream title.","description":"Set the title of the currently streaming content.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"Streaming my favorite game, Desert Bus."}}}}}},"/api/integrations/chat/send":{"post":{"summary":"Send a chat message.","description":"Send a chat message on behalf of a 3rd party integration, bot or service.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The message text that will be sent as the user."}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/system":{"post":{"summary":"Send a system chat message.","description":"Send a chat message on behalf of the system/server.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The message text that will be sent as the system user."}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/action":{"post":{"summary":"Send a chat action.","description":"Send an action that took place to the chat.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message text that will be sent as the system user.","example":"rolled a 15 on the dice"},"author":{"type":"string","description":"An optional user name that performed the action.","example":"JohnSmith"}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/system/client/{clientId}":{"post":{"summary":"Send system chat message to a client, identified by its ClientId","description":"Send a chat message on behalf of the system/server to a single client.","tags":["Integrations"],"security":[{"AccessToken":[]}],"parameters":[{"name":"clientId","in":"path","description":"Client ID (a unique numeric Id, identifying the client connection)","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message text that will be sent to the client.","example":"What a beautiful day. I love it"}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"messages":{"type":"string","example":"sent"}}}}}},"500":{"description":"Message was not sent to the client","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"message explaining what went wrong sending the message to the client"}}}}}}}}},"/api/admin/accesstokens/create":{"post":{"summary":"Create an access token.","description":"Create a single access token that has access to the access scopes provided.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The human-readable name to give this access token."},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Token was created.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"your new token"},"token":{"type":"string","example":"zG2xO-mHTFnelCp5xaIkYEFWcPhoOswOSRmFC1BkI="}}}}}}}}},"/api/admin/accesstokens/delete":{"post":{"summary":"Delete an access token.","description":"Delete a single access token.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"The token to delete"}}}}}},"responses":{"200":{"description":"Token was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"deleted token"}}}}}}}}},"/api/admin/accesstokens":{"get":{"summary":"Return all access tokens.","description":"Return all of the available access tokens.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Tokens are returned","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/admin/webhooks":{"get":{"summary":"Return all webhooks.","description":"Return all of the configured webhooks for external events.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Webhooks are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}}}},"/api/admin/config/externalactions":{"post":{"summary":"Set external action URLs.","description":"Set a collection of external action URLs that are displayed in the UI.","tags":["Admin","Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL of the external action content."},"title":{"type":"string","description":"The title to put on the external action button."},"description":{"type":"string","description":"Optional additional description to display in the UI."},"icon":{"type":"string","description":"The URL to an image to place on the external action button."},"color":{"type":"string","description":"Optional color to use for drawing the action button."},"openExternally":{"type":"boolean","description":"If set this action will open in a new browser tab instead of an internal modal."}}}}}}},"responses":{"200":{"description":"Actions have been updated."}}}},"/api/admin/webhooks/delete":{"post":{"summary":"Delete a single webhook.","description":"Delete a single webhook by its ID.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The webhook id to delete"}}}}}},"responses":{"200":{"description":"Webhook is deleted"}}}},"/api/admin/webhooks/create":{"post":{"summary":"Create a webhook.","description":"Create a single webhook that acts on the requested events.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The url to post the events to."},"events":{"description":"The events to be notified about.","type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Token was created.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"your new token"},"token":{"type":"string","example":"zG2xO-mHTFnelCp5xaIkYEFWcPhoOswOSRmFC1BkI="}}}}}}}}},"/api/integrations/clients":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/ClientsResponse"}}}},"/api/integrations/chat":{"get":{"summary":"Historical Chat Messages","description":"Used to get the backlog of chat messages.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/integrations/chat/updatemessagevisibility":{"post":{"summary":"Update the visibility of chat messages.","description":"Pass an array of IDs you want to change the chat visibility of.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"visible":{"type":"boolean","description":"Are these messages visible."},"idArray":{"type":"array","items":{"type":"string","description":"IDs of the chat messages you wish to change the visibility of."}}}}}}},"tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}}}}},"searchIndex":{"store":["section/Authentication","tag/Admin","tag/Admin/paths/~1api~1admin~1status/get","tag/Admin/paths/~1api~1admin~1disconnect/post","tag/Admin/paths/~1api~1admin~1yp~1reset/post","tag/Admin/paths/~1api~1admin~1chat~1clients/get","tag/Admin/paths/~1api~1admin~1users~1disabled/get","tag/Admin/paths/~1api~1admin~1logs/get","tag/Admin/paths/~1api~1admin~1logs~1warnings/get","tag/Admin/paths/~1api~1admin~1serverconfig/get","tag/Admin/paths/~1api~1admin~1chat~1messages/get","tag/Admin/paths/~1api~1admin~1chat~1updatemessagevisibility/post","tag/Admin/paths/~1api~1admin~1chat~1users~1setenabled/post","tag/Admin/paths/~1api~1admin~1config~1key/post","tag/Admin/paths/~1api~1admin~1config~1pagecontent/post","tag/Admin/paths/~1api~1admin~1config~1streamtitle/post","tag/Admin/paths/~1api~1admin~1config~1name/post","tag/Admin/paths/~1api~1admin~1config~1serversummary/post","tag/Admin/paths/~1api~1admin~1config~1logo/post","tag/Admin/paths/~1api~1admin~1config~1tags/post","tag/Admin/paths/~1api~1admin~1config~1ffmpegpath/post","tag/Admin/paths/~1api~1admin~1config~1webserverport/post","tag/Admin/paths/~1api~1admin~1config~1rtmpserverport/post","tag/Admin/paths/~1api~1admin~1config~1nsfw/post","tag/Admin/paths/~1api~1admin~1config~1directoryenabled/post","tag/Admin/paths/~1api~1admin~1config~1serverurl/post","tag/Admin/paths/~1api~1admin~1config~1video~1streamlatencylevel/post","tag/Admin/paths/~1api~1admin~1config~1video~1streamoutputvariants/post","tag/Admin/paths/~1api~1admin~1config~1video~1codec/post","tag/Admin/paths/~1api~1admin~1config~1s3/post","tag/Admin/paths/~1api~1admin~1config~1socialhandles/post","tag/Admin/paths/~1api~1admin~1config~1customstyles/post","tag/Admin/paths/~1api~1admin~1viewersOverTime/get","tag/Admin/paths/~1api~1admin~1hardwarestats/get","tag/Admin/paths/~1api~1admin~1webhooks/get","tag/Admin/paths/~1api~1admin~1config~1externalactions/post","tag/Admin/paths/~1api~1admin~1webhooks~1delete/post","tag/Admin/paths/~1api~1admin~1webhooks~1create/post","tag/Chat","tag/Chat/paths/~1api~1chat~1register/post","tag/Chat/paths/~1api~1chat/get","tag/Chat/paths/~1api~1emoji/get","tag/Integrations","tag/Integrations/paths/~1api~1integrations~1streamtitle/post","tag/Integrations/paths/~1api~1integrations~1chat~1send/post","tag/Integrations/paths/~1api~1integrations~1chat~1system/post","tag/Integrations/paths/~1api~1integrations~1chat~1action/post","tag/Integrations/paths/~1api~1integrations~1chat~1system~1client~1{clientId}/post","tag/Integrations/paths/~1api~1admin~1accesstokens~1create/post","tag/Integrations/paths/~1api~1admin~1accesstokens~1delete/post","tag/Integrations/paths/~1api~1admin~1accesstokens/get","tag/Integrations/paths/~1api~1admin~1config~1externalactions/post","tag/Integrations/paths/~1api~1integrations~1clients/get","tag/Integrations/paths/~1api~1integrations~1chat/get","tag/Integrations/paths/~1api~1integrations~1chat~1updatemessagevisibility/post","tag/Server","tag/Server/paths/~1api~1config/get","tag/Server/paths/~1api~1ping/get","tag/Server/paths/~1api~1status/get","tag/Server/paths/~1api~1yp/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.469]],["description/0",[1,5.749,2,4.44,3,4.44]],["title/1",[4,3.998]],["description/1",[0,3.828,4,3.425,5,4.44,6,4.44]],["title/2",[7,1.036,8,3.318,9,2.499]],["description/2",[]],["title/3",[9,2.868,10,3.808]],["description/3",[9,2.232,10,2.963,11,2.651,12,2.651,13,1.399,14,3.437,15,3.437,16,3.437]],["title/4",[17,2.94,18,2.94,19,2.94,20,2.399]],["description/4",[17,2.417,18,2.417,19,3.597,20,1.972,21,1.199,22,2.803,23,1.262,24,1.694,25,2.803,26,2.417,27,2.803]],["title/5",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/5",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/6",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/6",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/7",[28,1.261,36,2.63,37,2.399,38,3.41]],["description/7",[7,1.289,28,1.771,37,3.37]],["title/8",[28,1.132,36,2.361,37,2.153,39,2.639,40,2.639]],["description/8",[28,1.53,36,3.192,37,2.911,39,3.568,40,3.568]],["title/9",[7,1.189,41,2.499]],["description/9",[7,1.195,23,1.999,30,1.999,41,2.512]],["title/10",[42,0.947,43,1.423,44,3.849]],["description/10",[29,2.201,42,1.019,43,1.53,45,3.568,46,4.138]],["title/11",[42,0.839,43,1.261,47,2.63,48,2.399]],["description/11",[42,0.897,48,2.563,49,3.14,50,3.14,51,2.81,52,3.14,53,3.14]],["title/12",[54,2.63,55,2.94,56,1.813,57,2.06]],["description/12",[42,0.801,43,1.203,54,2.509,55,4.009,56,1.73,57,1.966,58,3.253,59,3.253]],["title/13",[13,1.566,20,2.707,60,0.425]],["description/13",[4,2.989,13,1.577,20,2.726,21,1.657,60,0.428,61,3.875]],["title/14",[60,0.377,62,2.214,63,2.214,64,2.214]],["description/14",[21,1.657,60,0.428,62,2.516,63,2.516,64,2.516,65,3.875]],["title/15",[13,1.566,60,0.425,66,2.707]],["description/15",[13,1.684,30,1.863,60,0.457,64,2.687,66,2.911]],["title/16",[7,1.036,60,0.425,67,3.318]],["description/16",[7,0.98,60,0.403,67,4.341,68,3.643,69,3.643,70,3.643]],["title/17",[7,1.036,60,0.425,71,3.318]],["description/17",[13,1.684,60,0.457,64,2.687,71,3.568,72,4.138]],["title/18",[7,1.036,60,0.425,73,3.318]],["description/18",[7,1.043,60,0.428,73,3.34,74,2.989,75,3.875,76,3.875]],["title/19",[7,1.036,60,0.425,77,3.318]],["description/19",[7,0.925,24,2.077,60,0.38,77,2.963,78,2.651,79,3.437,80,3.437,81,2.963]],["title/20",[60,0.377,74,2.63,82,2.94,83,3.41]],["description/20",[60,0.428,74,2.989,82,3.34,84,3.34,85,3.875,86,2.726]],["title/21",[23,1.535,60,0.377,87,2.399,88,2.399]],["description/21",[7,1.043,23,1.745,60,0.428,87,2.726,88,2.726,89,3.34]],["title/22",[7,0.824,12,2.361,60,0.338,88,2.153,90,3.06]],["description/22",[9,2.365,12,2.81,23,1.64,60,0.403,88,2.563,89,3.14,91,2.81]],["title/23",[13,1.388,92,2.63,93,2.94,94,2.94]],["description/23",[13,1.141,21,1.199,24,1.694,45,2.417,92,2.162,93,2.417,94,2.417,95,2.803,96,2.803,97,2.803,98,2.803,99,2.803]],["title/24",[7,0.824,23,1.378,24,1.849,60,0.338,100,2.153]],["description/24",[7,0.876,23,1.465,60,0.36,101,3.253,102,3.253,103,2.509,104,3.253,105,3.253,106,3.253]],["title/25",[7,0.824,23,1.378,60,0.338,107,2.639,108,1.849]],["description/25",[7,0.876,21,1.392,23,1.465,24,1.966,33,2.289,60,0.36,107,2.805,108,1.966,109,2.509]],["title/26",[13,1.388,60,0.377,110,2.94,111,2.63]],["description/26",[7,0.637,60,0.262,81,2.041,110,3.163,111,1.826,112,2.367,113,2.367,114,1.826,115,3.669,116,2.367,117,1.43,118,2.367,119,2.367,120,2.367]],["title/27",[13,1.388,41,1.929,60,0.377,121,3.41]],["description/27",[13,1.577,35,2.516,41,2.192,60,0.428,100,2.726,122,3.875]],["title/28",[60,0.425,114,2.969,123,3.318]],["description/28",[21,1.098,60,0.284,84,2.213,86,1.806,100,2.747,114,3.011,123,4.074,124,2.567,125,2.213,126,2.567]],["title/29",[60,0.425,127,3.318,128,3.849]],["description/29",[35,2.112,41,1.84,54,2.509,60,0.36,127,4.009,129,3.253,130,2.805,131,1.84]],["title/30",[60,0.425,132,3.318,133,3.849]],["description/30",[60,0.428,131,2.192,132,3.34,134,3.875,135,3.875,136,3.875]],["title/31",[21,1.087,62,1.65,87,1.787,137,2.19,138,2.54,139,2.54,140,1.787]],["description/31",[63,2.232,87,2.418,137,2.963,141,3.437,142,3.437,143,3.437,144,3.437,145,3.437]],["title/32",[117,2.326,146,2.969,147,3.849]],["description/32",[117,2.341,146,2.989,148,3.34,149,3.34,150,2.726,151,2.989]],["title/33",[125,3.808,152,4.417]],["description/33",[111,2.651,146,2.651,150,2.418,151,2.651,153,3.437,154,3.437,155,3.437,156,3.437]],["title/34",[28,1.633,157,2.669]],["description/34",[28,1.53,41,2.341,131,2.341,157,2.501,158,3.568]],["title/35",[60,0.377,108,2.06,131,1.929,159,2.06]],["description/35",[60,0.403,78,2.81,108,2.201,131,2.06,150,2.563,159,2.201,160,3.14]],["title/36",[56,2.047,157,2.326,161,2.707]],["description/36",[51,3.425,56,2.362,157,2.683,161,3.124]],["title/37",[157,2.669,162,3.108]],["description/37",[56,2.061,157,2.341,158,3.34,162,2.726,163,3.875,164,3.875]],["title/38",[42,1.276]],["description/38",[42,1.093,140,3.124,165,4.44,166,3.425]],["title/39",[42,0.947,57,2.326,103,2.969]],["description/39",[28,1.347,42,0.897,57,2.201,103,2.81,167,2.848,168,2.06]],["title/40",[42,0.947,43,1.423,169,3.318]],["description/40",[21,1.657,31,2.192,42,0.954,43,1.433,170,3.875,171,3.875]],["title/41",[62,2.868,172,3.808]],["description/41",[29,2.201,42,1.019,62,2.687,100,2.911,172,3.568]],["title/42",[109,3.998]],["description/42",[7,0.925,23,1.548,26,2.963,173,3.437,174,3.437,175,2.963,176,2.963,177,3.437]],["title/43",[13,1.566,60,0.425,66,2.707]],["description/43",[13,1.684,30,1.863,60,0.457,64,2.687,66,2.911]],["title/44",[42,0.947,43,1.423,178,2.047]],["description/44",[42,0.801,43,1.203,91,2.509,109,2.509,175,2.805,176,2.805,178,1.73,179,2.509,180,3.253]],["title/45",[42,0.839,43,1.261,86,2.399,178,1.813]],["description/45",[42,1.019,43,1.53,178,2.201,179,3.192,181,3.568]],["title/46",[42,0.947,159,2.326,178,2.047]],["description/46",[42,1.019,159,2.501,178,2.201,182,4.138,183,4.138]],["title/47",[32,1.275,42,0.625,43,0.939,86,1.787,178,1.351,184,2.54,185,2.54]],["description/47",[32,1.828,42,0.897,43,1.347,56,1.937,178,1.937,179,2.81,181,3.14]],["title/48",[162,2.707,167,2.177,168,2.177]],["description/48",[56,1.828,130,2.963,162,2.418,167,3.164,168,1.944,186,3.437]],["title/49",[161,2.707,167,2.177,168,2.177]],["description/49",[56,2.362,161,3.124,167,2.512,168,2.512]],["title/50",[28,1.423,167,2.177,168,2.177]],["description/50",[28,1.642,167,2.512,168,2.512,187,4.44]],["title/51",[60,0.377,108,2.06,131,1.929,159,2.06]],["description/51",[60,0.403,78,2.81,108,2.201,131,2.06,150,2.563,159,2.201,160,3.14]],["title/52",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/52",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/53",[42,0.947,43,1.423,188,3.849]],["description/53",[21,1.899,42,1.093,43,1.642,169,3.828]],["title/54",[42,0.839,43,1.261,47,2.63,48,2.399]],["description/54",[42,0.897,48,2.563,49,3.14,50,3.14,51,2.81,52,3.14,53,3.14]],["title/55",[7,1.395]],["description/55",[]],["title/56",[189,3.366]],["description/56",[21,1.657,32,1.944,41,2.192,57,2.341,166,2.989,189,2.516]],["title/57",[11,2.63,30,1.535,92,2.63,117,2.06]],["description/57",[117,2.201,140,2.563,148,3.14,149,3.14,151,2.81,190,3.643,191,3.643]],["title/58",[8,3.808,30,1.989]],["description/58",[7,0.691,9,1.667,11,1.98,21,1.67,47,1.98,57,1.551,117,1.551,140,1.806,166,1.98,189,1.667,192,2.567,193,2.567,194,2.567]],["title/59",[63,2.499,189,2.499,195,3.318]],["description/59",[7,0.876,21,1.392,23,1.465,24,1.966,63,2.112,91,2.509,189,2.112,195,2.805,196,3.253]]],"invertedIndex":[["",{"_index":1,"title":{},"description":{"0":{}}}],["3rd",{"_index":175,"title":{},"description":{"42":{},"44":{}}}],["acceler",{"_index":126,"title":{},"description":{"28":{}}}],["access",{"_index":167,"title":{"48":{},"49":{},"50":{}},"description":{"39":{},"48":{},"49":{},"50":{}}}],["act",{"_index":163,"title":{},"description":{"37":{}}}],["action",{"_index":159,"title":{"35":{},"46":{},"51":{}},"description":{"35":{},"46":{},"51":{}}}],["activ",{"_index":11,"title":{"57":{}},"description":{"3":{},"58":{}}}],["admin",{"_index":4,"title":{"1":{}},"description":{"1":{},"13":{}}}],["allow",{"_index":174,"title":{},"description":{"42":{}}}],["api",{"_index":26,"title":{},"description":{"4":{},"42":{}}}],["appli",{"_index":46,"title":{},"description":{"10":{}}}],["array",{"_index":50,"title":{},"description":{"11":{},"54":{}}}],["associ",{"_index":68,"title":{},"description":{"16":{}}}],["attempt",{"_index":102,"title":{},"description":{"24":{}}}],["authent",{"_index":0,"title":{"0":{}},"description":{"1":{}}}],["avail",{"_index":187,"title":{},"description":{"50":{}}}],["backlog",{"_index":169,"title":{"40":{}},"description":{"53":{}}}],["behalf",{"_index":179,"title":{},"description":{"44":{},"45":{},"47":{}}}],["between",{"_index":116,"title":{},"description":{"26":{}}}],["binari",{"_index":83,"title":{"20":{}},"description":{}}],["bot",{"_index":180,"title":{},"description":{"44":{}}}],["broadcast",{"_index":9,"title":{"2":{},"3":{}},"description":{"3":{},"22":{},"58":{}}}],["buffer",{"_index":115,"title":{},"description":{"26":{}}}],["built",{"_index":173,"title":{},"description":{"42":{}}}],["categori",{"_index":79,"title":{},"description":{"19":{}}}],["chang",{"_index":53,"title":{},"description":{"11":{},"54":{}}}],["chat",{"_index":42,"title":{"10":{},"11":{},"38":{},"39":{},"40":{},"44":{},"45":{},"46":{},"47":{},"53":{},"54":{}},"description":{"10":{},"11":{},"12":{},"38":{},"39":{},"40":{},"41":{},"44":{},"45":{},"46":{},"47":{},"53":{},"54":{}}}],["client",{"_index":32,"title":{"5":{},"6":{},"47":{},"52":{}},"description":{"5":{},"6":{},"47":{},"52":{},"56":{}}}],["clientid",{"_index":185,"title":{"47":{}},"description":{}}],["codec",{"_index":123,"title":{"28":{}},"description":{"28":{}}}],["collect",{"_index":150,"title":{},"description":{"32":{},"33":{},"35":{},"51":{}}}],["configr",{"_index":128,"title":{"29":{}},"description":{}}],["configur",{"_index":41,"title":{"9":{},"27":{}},"description":{"9":{},"27":{},"29":{},"34":{},"56":{}}}],["connect",{"_index":31,"title":{"5":{},"6":{},"52":{}},"description":{"5":{},"6":{},"40":{},"52":{}}}],["consit",{"_index":95,"title":{},"description":{"23":{}}}],["contain",{"_index":143,"title":{},"description":{"31":{}}}],["content",{"_index":64,"title":{"14":{}},"description":{"14":{},"15":{},"17":{},"43":{}}}],["context",{"_index":97,"title":{},"description":{"23":{}}}],["copi",{"_index":85,"title":{},"description":{"20":{}}}],["count",{"_index":149,"title":{},"description":{"32":{},"57":{}}}],["cpu",{"_index":153,"title":{},"description":{"33":{}}}],["creat",{"_index":162,"title":{"37":{},"48":{}},"description":{"37":{},"48":{}}}],["css",{"_index":137,"title":{"31":{}},"description":{"31":{}}}],["current",{"_index":30,"title":{"5":{},"6":{},"52":{},"57":{},"58":{}},"description":{"5":{},"6":{},"9":{},"15":{},"43":{},"52":{}}}],["custom",{"_index":62,"title":{"14":{},"31":{},"41":{}},"description":{"14":{},"41":{}}}],["default",{"_index":106,"title":{},"description":{"24":{}}}],["delet",{"_index":161,"title":{"36":{},"49":{}},"description":{"36":{},"49":{}}}],["detail",{"_index":35,"title":{},"description":{"5":{},"6":{},"27":{},"29":{},"52":{}}}],["determin",{"_index":112,"title":{},"description":{"26":{}}}],["differ",{"_index":96,"title":{},"description":{"23":{}}}],["directori",{"_index":24,"title":{"24":{}},"description":{"4":{},"19":{},"23":{},"25":{},"59":{}}}],["directory](https://directory.owncast.onlin",{"_index":105,"title":{},"description":{"24":{}}}],["disabl",{"_index":55,"title":{"12":{}},"description":{"12":{}}}],["disconnect",{"_index":10,"title":{"3":{}},"description":{"3":{}}}],["discov",{"_index":192,"title":{},"description":{"58":{}}}],["disk",{"_index":155,"title":{},"description":{"33":{}}}],["display",{"_index":78,"title":{},"description":{"19":{},"35":{},"51":{}}}],["emoji",{"_index":172,"title":{"41":{}},"description":{"41":{}}}],["enabl",{"_index":54,"title":{"12":{}},"description":{"12":{},"29":{}}}],["encod",{"_index":124,"title":{},"description":{"28":{}}}],["end",{"_index":119,"title":{},"description":{"26":{}}}],["endpoint",{"_index":140,"title":{"31":{}},"description":{"38":{},"57":{},"58":{}}}],["entri",{"_index":38,"title":{"7":{}},"description":{}}],["error",{"_index":40,"title":{"8":{}},"description":{"8":{}}}],["event",{"_index":158,"title":{},"description":{"34":{},"37":{}}}],["exist",{"_index":15,"title":{},"description":{"3":{}}}],["extern",{"_index":131,"title":{"35":{},"51":{}},"description":{"29":{},"30":{},"34":{},"35":{},"51":{}}}],["ffmpeg",{"_index":82,"title":{"20":{}},"description":{"20":{}}}],["filter",{"_index":45,"title":{},"description":{"10":{},"23":{}}}],["front",{"_index":139,"title":{"31":{}},"description":{}}],["frontend",{"_index":145,"title":{},"description":{"31":{}}}],["geo",{"_index":34,"title":{},"description":{"5":{},"6":{},"52":{}}}],["global",{"_index":196,"title":{},"description":{"59":{}}}],["handl",{"_index":133,"title":{"30":{}},"description":{}}],["hardwar",{"_index":125,"title":{"33":{}},"description":{"28":{}}}],["hide",{"_index":58,"title":{},"description":{"12":{}}}],["histor",{"_index":188,"title":{"53":{}},"description":{}}],["hit",{"_index":190,"title":{},"description":{"57":{}}}],["id",{"_index":51,"title":{},"description":{"11":{},"36":{},"54":{}}}],["ident",{"_index":70,"title":{},"description":{"16":{}}}],["identifi",{"_index":184,"title":{"47":{}},"description":{}}],["inbound",{"_index":12,"title":{"22":{}},"description":{"3":{},"22":{}}}],["includ",{"_index":98,"title":{},"description":{"23":{}}}],["inform",{"_index":189,"title":{"56":{},"59":{}},"description":{"56":{},"58":{},"59":{}}}],["insert",{"_index":144,"title":{},"description":{"31":{}}}],["integr",{"_index":109,"title":{"42":{}},"description":{"25":{},"44":{}}}],["interact",{"_index":177,"title":{},"description":{"42":{}}}],["interfac",{"_index":166,"title":{},"description":{"38":{},"56":{},"58":{}}}],["itself",{"_index":104,"title":{},"description":{"24":{}}}],["key",{"_index":20,"title":{"4":{},"13":{}},"description":{"4":{},"13":{}}}],["latenc",{"_index":110,"title":{"26":{}},"description":{"26":{}}}],["less",{"_index":118,"title":{},"description":{"26":{}}}],["level",{"_index":111,"title":{"26":{}},"description":{"26":{},"33":{}}}],["link",{"_index":134,"title":{},"description":{"30":{}}}],["list",{"_index":29,"title":{"5":{},"6":{},"52":{}},"description":{"5":{},"6":{},"10":{},"41":{},"52":{}}}],["listen",{"_index":89,"title":{},"description":{"21":{},"22":{}}}],["local",{"_index":27,"title":{},"description":{"4":{}}}],["log",{"_index":37,"title":{"7":{},"8":{}},"description":{"7":{},"8":{}}}],["logo",{"_index":73,"title":{"18":{}},"description":{"18":{}}}],["mark",{"_index":92,"title":{"23":{},"57":{}},"description":{"23":{}}}],["markdown",{"_index":65,"title":{},"description":{"14":{}}}],["memori",{"_index":154,"title":{},"description":{"33":{}}}],["messag",{"_index":43,"title":{"10":{},"11":{},"40":{},"44":{},"45":{},"47":{},"53":{},"54":{}},"description":{"10":{},"12":{},"40":{},"44":{},"45":{},"47":{},"53":{}}}],["more",{"_index":120,"title":{},"description":{"26":{}}}],["much",{"_index":113,"title":{},"description":{"26":{}}}],["name",{"_index":67,"title":{"16":{}},"description":{"16":{}}}],["network",{"_index":135,"title":{},"description":{"30":{}}}],["number",{"_index":193,"title":{},"description":{"58":{}}}],["on",{"_index":14,"title":{},"description":{"3":{}}}],["oper",{"_index":5,"title":{},"description":{"1":{}}}],["option",{"_index":33,"title":{},"description":{"5":{},"6":{},"25":{},"52":{}}}],["output",{"_index":121,"title":{"27":{}},"description":{}}],["over",{"_index":146,"title":{"32":{}},"description":{"32":{},"33":{}}}],["owncast",{"_index":23,"title":{"21":{},"24":{},"25":{}},"description":{"4":{},"9":{},"21":{},"22":{},"24":{},"25":{},"42":{},"59":{}}}],["page",{"_index":63,"title":{"14":{},"59":{}},"description":{"14":{},"31":{},"59":{}}}],["parti",{"_index":176,"title":{},"description":{"42":{},"44":{}}}],["pass",{"_index":49,"title":{},"description":{"11":{},"54":{}}}],["password",{"_index":61,"title":{},"description":{"13":{}}}],["path",{"_index":74,"title":{"20":{}},"description":{"18":{},"20":{}}}],["period",{"_index":151,"title":{},"description":{"32":{},"33":{},"57":{}}}],["ping",{"_index":191,"title":{},"description":{"57":{}}}],["place",{"_index":183,"title":{},"description":{"46":{}}}],["port",{"_index":88,"title":{"21":{},"22":{}},"description":{"21":{},"22":{}}}],["prior",{"_index":170,"title":{},"description":{"40":{}}}],["problem",{"_index":22,"title":{},"description":{"4":{}}}],["profil",{"_index":136,"title":{},"description":{"30":{}}}],["provid",{"_index":130,"title":{},"description":{"29":{},"48":{}}}],["public",{"_index":107,"title":{"25":{}},"description":{"25":{}}}],["purpos",{"_index":99,"title":{},"description":{"23":{}}}],["recent",{"_index":36,"title":{"7":{},"8":{}},"description":{"8":{}}}],["redoc-inject",{"_index":2,"title":{},"description":{"0":{}}}],["regist",{"_index":103,"title":{"39":{}},"description":{"24":{},"39":{}}}],["registr",{"_index":19,"title":{"4":{}},"description":{"4":{}}}],["rel",{"_index":75,"title":{},"description":{"18":{}}}],["relat",{"_index":165,"title":{},"description":{"38":{}}}],["request",{"_index":164,"title":{},"description":{"37":{}}}],["requir",{"_index":6,"title":{},"description":{"1":{}}}],["reset",{"_index":17,"title":{"4":{}},"description":{"4":{}}}],["return",{"_index":28,"title":{"5":{},"6":{},"7":{},"8":{},"34":{},"50":{},"52":{}},"description":{"5":{},"6":{},"7":{},"8":{},"34":{},"39":{},"50":{},"52":{}}}],["rtmp",{"_index":90,"title":{"22":{}},"description":{}}],["s3",{"_index":129,"title":{},"description":{"29":{}}}],["safe",{"_index":93,"title":{"23":{}},"description":{"23":{}}}],["save",{"_index":141,"title":{},"description":{"31":{}}}],["scope",{"_index":186,"title":{},"description":{"48":{}}}],["security-definit",{"_index":3,"title":{},"description":{"0":{}}}],["send",{"_index":178,"title":{"44":{},"45":{},"46":{},"47":{}},"description":{"44":{},"45":{},"46":{},"47":{}}}],["server",{"_index":7,"title":{"2":{},"9":{},"16":{},"17":{},"18":{},"19":{},"22":{},"24":{},"25":{},"55":{}},"description":{"7":{},"9":{},"16":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"42":{},"58":{},"59":{}}}],["server'",{"_index":72,"title":{},"description":{"17":{}}}],["servic",{"_index":91,"title":{},"description":{"22":{},"44":{},"59":{}}}],["set",{"_index":60,"title":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"35":{},"43":{},"51":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"35":{},"43":{},"51":{}}}],["show",{"_index":80,"title":{},"description":{"19":{}}}],["singl",{"_index":56,"title":{"12":{},"36":{}},"description":{"12":{},"36":{},"37":{},"47":{},"48":{},"49":{}}}],["social",{"_index":132,"title":{"30":{}},"description":{"30":{}}}],["specif",{"_index":84,"title":{},"description":{"20":{},"28":{}}}],["stat",{"_index":152,"title":{"33":{}},"description":{}}],["statu",{"_index":8,"title":{"2":{},"58":{}},"description":{}}],["storag",{"_index":127,"title":{"29":{}},"description":{"29":{}}}],["stream",{"_index":13,"title":{"13":{},"15":{},"23":{},"26":{},"27":{},"43":{}},"description":{"3":{},"13":{},"15":{},"17":{},"23":{},"27":{},"43":{}}}],["string",{"_index":142,"title":{},"description":{"31":{}}}],["style",{"_index":138,"title":{"31":{}},"description":{}}],["summari",{"_index":71,"title":{"17":{}},"description":{"17":{}}}],["support",{"_index":100,"title":{"24":{}},"description":{"27":{},"28":{},"41":{}}}],["system",{"_index":86,"title":{"45":{},"47":{}},"description":{"20":{},"28":{}}}],["system/serv",{"_index":181,"title":{},"description":{"45":{},"47":{}}}],["tag",{"_index":77,"title":{"19":{}},"description":{"19":{}}}],["termin",{"_index":16,"title":{},"description":{"3":{}}}],["time",{"_index":147,"title":{"32":{}},"description":{}}],["titl",{"_index":66,"title":{"15":{},"43":{}},"description":{"15":{},"43":{}}}],["token",{"_index":168,"title":{"48":{},"49":{},"50":{}},"description":{"39":{},"48":{},"49":{},"50":{}}}],["took",{"_index":182,"title":{},"description":{"46":{}}}],["track",{"_index":148,"title":{},"description":{"32":{},"57":{}}}],["true",{"_index":101,"title":{},"description":{"24":{}}}],["ui",{"_index":160,"title":{},"description":{"35":{},"51":{}}}],["unfilt",{"_index":44,"title":{"10":{}},"description":{}}],["up",{"_index":81,"title":{},"description":{"19":{},"26":{}}}],["updat",{"_index":47,"title":{"11":{},"54":{}},"description":{"58":{}}}],["url",{"_index":108,"title":{"25":{},"35":{},"51":{}},"description":{"25":{},"35":{},"51":{}}}],["us",{"_index":21,"title":{"31":{}},"description":{"4":{},"13":{},"14":{},"23":{},"25":{},"28":{},"40":{},"53":{},"56":{},"58":{},"59":{}}}],["user",{"_index":57,"title":{"12":{},"39":{}},"description":{"12":{},"39":{},"56":{},"58":{}}}],["user'",{"_index":59,"title":{},"description":{"12":{}}}],["usernam",{"_index":69,"title":{},"description":{"16":{}}}],["util",{"_index":156,"title":{},"description":{"33":{}}}],["variant",{"_index":122,"title":{},"description":{"27":{}}}],["via",{"_index":25,"title":{},"description":{"4":{}}}],["video",{"_index":114,"title":{"28":{}},"description":{"26":{},"28":{}}}],["viewer",{"_index":117,"title":{"32":{},"57":{}},"description":{"26":{},"32":{},"57":{},"58":{}}}],["visibl",{"_index":48,"title":{"11":{},"54":{}},"description":{"11":{},"54":{}}}],["want",{"_index":52,"title":{},"description":{"11":{},"54":{}}}],["warn",{"_index":39,"title":{"8":{}},"description":{"8":{}}}],["web",{"_index":87,"title":{"21":{},"31":{}},"description":{"21":{},"31":{}}}],["webhook",{"_index":157,"title":{"34":{},"36":{},"37":{}},"description":{"34":{},"36":{},"37":{}}}],["webroot",{"_index":76,"title":{},"description":{"18":{}}}],["websocket",{"_index":171,"title":{},"description":{"40":{}}}],["well",{"_index":194,"title":{},"description":{"58":{}}}],["work",{"_index":94,"title":{"23":{}},"description":{"23":{}}}],["yellow",{"_index":195,"title":{"59":{}},"description":{"59":{}}}],["yp",{"_index":18,"title":{"4":{}},"description":{"4":{}}}]],"pipeline":[]}},"options":{"hideHostname":true,"pathInMiddlePanel":true}}; + const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.1","info":{"title":"Owncast","description":"Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development branch.\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->","version":"0.0.9","contact":{"name":"Gabe Kangas","email":"gabek@real-ity.com","url":"http://owncast.online"},"x-logo":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAEvmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNS41LjAiPgogPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iCiAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgIHhtbG5zOnBob3Rvc2hvcD0iaHR0cDovL25zLmFkb2JlLmNvbS9waG90b3Nob3AvMS4wLyIKICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIgogICAgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIKICAgZXhpZjpQaXhlbFhEaW1lbnNpb249IjEyOCIKICAgZXhpZjpQaXhlbFlEaW1lbnNpb249IjEyOCIKICAgZXhpZjpDb2xvclNwYWNlPSIxIgogICB0aWZmOkltYWdlV2lkdGg9IjEyOCIKICAgdGlmZjpJbWFnZUxlbmd0aD0iMTI4IgogICB0aWZmOlJlc29sdXRpb25Vbml0PSIyIgogICB0aWZmOlhSZXNvbHV0aW9uPSI5Ni4wIgogICB0aWZmOllSZXNvbHV0aW9uPSI5Ni4wIgogICBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIgogICBwaG90b3Nob3A6SUNDUHJvZmlsZT0ic1JHQiBJRUM2MTk2Ni0yLjEiCiAgIHhtcDpNb2RpZnlEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIgogICB4bXA6TWV0YWRhdGFEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIj4KICAgPHhtcE1NOkhpc3Rvcnk+CiAgICA8cmRmOlNlcT4KICAgICA8cmRmOmxpCiAgICAgIHN0RXZ0OmFjdGlvbj0icHJvZHVjZWQiCiAgICAgIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFmZmluaXR5IERlc2lnbmVyIChNYXIgMzEgMjAyMCkiCiAgICAgIHN0RXZ0OndoZW49IjIwMjAtMDYtMThUMDA6NDY6MTItMDc6MDAiLz4KICAgIDwvcmRmOlNlcT4KICAgPC94bXBNTTpIaXN0b3J5PgogIDwvcmRmOkRlc2NyaXB0aW9uPgogPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KPD94cGFja2V0IGVuZD0iciI/Pn6jclUAAAGCaUNDUHNSR0IgSUVDNjE5NjYtMi4xAAAokXWRzytEURTHPzODESPCwsLipWE15EdNbJSZNNSkaYwy2Mw880PNj9d7I8lW2SpKbPxa8BewVdZKESlZWVgTG/ScZ6Zmkjm3c8/nfu89p3vPBXsko2aNmn7I5gp6OOBTZqNzivOZOlpx0oESUw1tLBQKUtU+7rBZ8abXqlX93L/WuJgwVLDVC4+qml4QnhAOrhQ0i7eF29V0bFH4VNijywWFby09XuQXi1NF/rJYj4T9YG8RVlIVHK9gNa1nheXluLOZZbV0H+slrkRuZlpil3gnBmEC+FCYZBw/XgYYkdlLL4P0yYoq+f2/+VPkJVeVWWMVnSVSpCngEXVZqickJkVPyMiwavX/b1+N5NBgsbrLB7VPpvnWDc4t+N40zc9D0/w+AscjXOTK+fkDGH4XfbOsufeheR3OLstafAfON6DjQYvpsV/JIW5PJuH1BJqi0HYNDfPFnpX2Ob6HyJp81RXs7kGPnG9e+AEyv2fOZnRq6wAAAAlwSFlzAAAOxAAADsQBlSsOGwAAHBpJREFUeJztfXl8VEW69vO852QhYYcAIRsGRETZ3BURRXGcn5/bOKPOOPPduRevv9EZh3tdRp1x+bjM6FXGXcdt3HGDO7ij1w0XRnHBBTAoypJASEjYlyzdp+r9/ugEmqQ7fbrTnaQDz+9XhD6n6q23u556q+qtDdiP/diPfRfsbAU6Gx/fpz36ZeJiUM8EMAzEAADZADIBGADbAdRCdbW1mFdXL88eMZ07O1PnZGKfJcA395sCOJgmgisB9vKbThXbVfF3Nfr4oZc4S1OpY0dgnyPAkpuV2sc7WRx5kURuO0RZazDLqN444VK3MWkKdjD2KQJ8ebe6jmsegMNfAshKgkhVq8uMxRmH/dYtT4K8Dsc+Q4DF93m9BXyIDs5PunBFuXp69oTL3K+SLjvF2CcI8Pm9XhbJJ0mcl8JsKuxOjD/iD86WFOaRdLidrUBHQIFZUJynmtJsitEDLwKYnNJckoxubwE+uSt4CYX3ApAOyM5aq78/ZnrGfR2QV1LQrQnw/h1eYabgGxK9OzDbOmtQeNx/umnRFHTbJuDD24MZQl1glb2RWtPfEjmATgPw1w7NNUF0hFnsFFiLi6xyuFWgwwN4w/uzgh1pdRJGt7QA784yBaC5z2qnNXG9VDgBwPudlL9vdEsCKM1lBmQHm/69dVA7FfsJ0PF4878bR1rldHZi4QOAgqcDuK5ztYiNbtcHUPLfVTXbqqKTw9hXbmzo2dm/Ryx0Kwsw50Z1rQYv7mw9miDM5kgAX3S2Im2hWxGgR3bwcgPt6GFfVKjaodhPgI6DVf1FZ+sQDlUO6GwdYqHbEGDOH+0gq8ExXaX2A4CiQz2QCaHbEAAZjXdZZRfr1GqXd7V3CwI886eGbHVxqulsRVpCaTtbhVjoFgQIKAZkqfbpSuYfAAit62wdYqFbEMDJ0EuMwulsPVpB0eVXD6c9Ae6+fHumAX6TqOfPGsAYQA1grUIt0HLhCAlQQkGEEAdwHPiYTNcNiWnVcUh7AuTkOMUWOqAt868aKmhrgWCjorEOCDQogoFQwScEAhlZQFY2kdkDyOxBiADihAgDANagKkHpHYa0J4ASw02kwlegfqdi145QQTcToBXaMW4wAaAhoMB2gNCQhXCAzCwgpxdMrpO1JnHpHYO0J4BRPaX5/8FGoKFO0VAfquGt1gCmelCmADwg4AE7d7Lsz89mBFKcY7uR9gQIGJwaaFDs2KoIdvT2jDYJZRd1lBrtQVoT4PLzt/WrWqdjdtd0n+ZcFQECj0J1IYB6BU6h8NcAeiRLN1V8lCxZqURaE0AcHGKgjMO0e7CYoca5f9ZzuZvCns+74hfbb3Cov4TwLwBy2qubiv2uvTI6AmlNABWMtv4Lvw5WfvPXp3s+Fenlbc/03gjgzssv3L5IHLyDdpBAQ/+sSjR9R6KL+c7jgzp6iKXCT/BUb/zr7MiFH47bn+69yBhztqWqX9kRwne3ze7b5X0AQJpbAAMe6Mv8q75sa/vc7luu4D1C14EsSkgxq7MSStcJSGsLYEVHKENzbtGCJRqt8vp73vA/MXP3U/2Clrg3luwoIaiC11L5vZOJtCXA+ecZscQBhoq2goU+cM+TfZbEK7+xUR6OJTtK2GVpN6fiO6cCaUuAXjnbhlvCtaFaHj2oPpKI/Iee7b3FEttjym8ZgAfufax/l3cANSNt+wB0dKSNMQOkiiWeeN8kmoel7kJ8q3oaxGTdkmh+nYG0JQDIEbGGgAr5/aOP5CW8KCOOIWYzvnnw8ZytiebXGUhbAnjUIrZRQATqAPN1e/Iw0Ky45g+Us9uTX2cgYQLMuP760szMzCtF5DQSRQTqAXwL1QVq7Wu7Nm7654y77krZKi0Fh7ZVOBZYr3C3Jyr/Zz+rcFXg+/QwADX0vIcSza+zkBAB/uuGG452MtyPFBCrFlSAQC+SRxI4UkT+0HPgwA9uufHGaXXAyhkzZiR9sZY66N+WUGv10ace6p2w+c/s13OsJTL8xrdq5zz1aF6XXwLWEnGPAq675pphCsw3nhFjPBjPgzEmFDwPxoQ+q9oT6MrXOYInZv7pT0lvagw1q42hmEqCvf9mkHpWPMM/haZd7QcSGQaKzDTW9je2qdCN3UOA8M/WwBqTA8WvMjOcT278w+Xjkqm4JbLbGI7VPPHwwJpEZZ9/8QZaB+f6H/rp/8x+MC8tD42MiwBXTp9eZK29wDYVtm1Z+DYCGaxBY2PjYW+9+uqno4fknZYsxS01sw1f/Pr2yFbX6WGphf59//TtZu5qiM8CuO7vjTFuyPQbeGaPyW/ZBBjPwBgPwUAAr7/4IrZt3ZopIi+MyR/0n8lQ3AJOtBppoJXtkq1abInefmq/Ib60MJ8m4zt1BuJqm9XaiQYKi9AUPImmv02fm/4vCH1Qa/HJwg+xdesWCAES2SRvHjt0cG6Q5qbllRsTH6OLRiWvEu0yx9bFzT539XgW+PW8vw3qcntS/CIuC2CMKQiZfgNrm9t7G/psDKzd0/4bz2BFWRkqVq9uKSZLhDOyIf8+bmhewmv5TdttcsIEOOeyjUNAnO2r9gPLgsYm7GnsCojLAhhrB9GGvjzB3RZAEfoPAQhDn6vXV+KrxYujDdWFIve7BvUAnkxEcQVstDpqIAmvxjGik33WikBjUH70+v15aVv7gTgIMG3atJ7GmOw9pj+MAGFNgJIINDTgy88/g6qiDW8d4fDhIwoH13++bsPceBU3olGbDxOUNfHKA4DJ01dnKO0M48f9p/ri6/fnJTzS6Crw3QRYa3vtHvM3dfBCf1t2/jx89ski1O3aFVMmgUyKPHRkweC4h4hKBKLM/wfn/21AQtOxucw5Q8mDfKwx2OxRktKZ7Wz4tgCe57kOuafD12QFQiYfAAEBUbm2AjXV1RCfPnQCfek6LwMoiUdxQwSjvNoWj5xwWOF0Xy5LxazX78xr11Czq8A3Aay1QWNtq8K3CBU8CTQGGrH064ROTC8+piT/HevZH31aucHzpQ+j7rytT0SBqVds+IlCj49JAMXXVu09ieTRFeG7CQgGgzt3m/qmJsDzQr1/Yzx4wSC++uILeF6o/Kzq6xb2/1iDCap6iaq+D0XUwiV4kuM4F/nVxxCbI4/LNZplaBMKvcESEqPnr0Hg0rfuzI/dvqUJfBNgzpw5Oz1j6vf29O0JmzZtRG1NqE9kVZesrNl0+g8bNr22orb2q2+rax8oq6o90RhzLlSj1VCK8P6JJflj/OhjoWsjeeWU8W8TP/HKDRepYFwsj5+Bvf3d2wenxYYPv4jXD1DVsuA9YxAMevhm6bLd8aj4I9B6v27Zho0vq9XRsPpxtDwIzj5+yJDsmLoQK6J45mKmDcfkq6p6QnRW7DG/VnvGuzEe2emA+AjgeT/scfuGTL81HirXrUVd3R6raKFRnSNLq2vXKOxJanUuIpCEwrHMdq6MpYvSLI9cWOp7CdfxV1ZnqvBxJfq2TQDd4VFP/eCOom5j+psRFwE8z3ve2z3xE5oMCgYNKsrL945ndFMUEQCAr9fXNn5ZueE8QF+O1Okied3xxYPaXJMfCJqvDNVGaAJ6HHVlua/j2dTV05V6bgzTrwZ618Jbh6blbF8sxGcBNPCM8czG8MmgtRXlaGjYu1kX8Xz5+NUGfwHV+S2fk8hynYy/t5V20R3FuyxRYUJmf68grjsqVt7HXVs9ToknIqVvEV60NjjDz/dJR8RFgFdeeaPBGPN8+BqADdXVreIRbn8/8hZXbqpTi4ugWtZaCKecOKzg+LbSW+pSpaJVEBzdVrojr1k3wNI+qtReEdPvCd9bay/7aFaJr6FpOiLuBSEWuMcYEzDGYNPGja1qPwA4Igf5lfd5ZXWVVVwAoOVaepfCZycXF0RdlmVgv4pUaxU6JVqasddWZUI4xxKHxaj5DR5w/qJbCto1tdzVETcB5s+f/50x3i3GeChfsyZiHAUuj0fmrgZvmar9OVp0CkkOFdojoqUzlE8jttvCiEPJCddXu5mOma+Ck2K0+8ajPb2xkWl3D2C8SGhnkDXm3vr6hppgMLLPheRppXn9f+RXXlltrRJ4RVtfsCDiOk+cUloY8ZZPemaRJTwrQItQNO66ymnhccdct7YY8F615MlWwAhpQoEIWuAKbTQLltyW38VOHkw+fHrsW6Mgb+ARxpiPhXClaX5AGHIPCwhCyxT2uJU1W3z75o8v7tMTTs8Kh+wXLk+tTnxn1bqIDpjxN1TOB/DjCK8aLexPAZQTPAHAzYx9SbSB4o6vZhZc5VfndEfCewMDgeBiVXtrtPckRwuc/4lH5sKKbTth7QMtnwtwabQ0Ru1DUcx4FsiXQX6hoZ2+vWKeIQDcErTe1fHonO5I2AI0I79/32cdkQtaWgAJTRgpYF8EcMGKDZt8bZg8tiS/Z4bIUiGHNcsjEFTPlry9prLVuXsHX792sDhYHzrGsR1Q/ZNCby2bUdxte/yR0O7dwVWbt/5SVV+N8ppCOUfI90YN6e9ruvfj8qqdqnhsLyFghrgSsU+xfGbRBqO4ox2neTQY6mXfzCi6aV8rfCA528NN0LPnQDXqoQikHCt0lx88ZGDU4dle8Y3OaS2DJ0WLbwUzLbEz7q3cxE7jmaO+vbHoXn9ftfshKecD1Gzb5sHi59bqfYjg3wcAEj0cceaPHTro6dFD8wrbkkdZ/x20xdJu1ajDwRU3Fm0zVn9rqcaKwk8w0LcscPiKmcO6pYvXL9rdBwhHSZ8+ggznekfkKofIbV40wua+QfNoAWgEcStUnwsE9Nuy2tq9XMcjRoAFpuA7R+TA3aMKImDMjty3V22JaqZLZ5bPIvkfaHuhS7kC9+4Ibr+zdsah+5zJb4mkEqAZJQP6jMlwMhYIOSAiAfYeLi4B7UyHzosE1AktI73IdeT+veIR8BqR/05FRWvfcxiGzSz/FQWPAHTDvp8FsNNac0PAy7ynakZBl7/IoaOQEgIAQOmg/vkO5GpHOL0tAuwmCFBPcqsAmUL2F4KtCBAMDnlnTVXM49eKbyofBIuRJAcpdCeAalpZVX59UZc/v7+jkTICNGPk4AFTHcp1IpwopNMGAfY8j2QpiJ1rv6/oWwak9Tr8roaUnxCyYsOmtwC8dfCQgWeIyL0gC4D4l22p6oKuXvhHH3W8S6Hr0HFE6IAUUsR4nus4zKLQccTxHMmoB6lCGhFaKDwReq/978sJrWdsD1JuAcJxSF7/XCfDPYrk1Y7wVAHpxwIQqKfi2DdXrm3XkS/JxoQJxw12XZ0kkKNBjnFEBlPYk5QeBHIokiVkBikZoWaQQOivJcUj2UiygeROEdkBYLOAnynxgQYC77369qspb7I6lADhGJ8/aJQIz3ZEThBynBBDIxDAI7CQ1l759urKxZ2lKwCMHTs+B3CPEPJIER4rIkeRLCIJEQEQKmAKQUp4YYMUtCBA6JkQ0uTAFAnFCcUTgAwIuBjCBSQXBAONH708f17STyDpNAK0xPghgwf3yJIjHCAfBBxwvbG7PlxYsW1HZ+l08MFje4lghFAuofDfRBwnVDiAMKzAUkOApngERUBgE4DrhM7c5+c91eaSu3jQZQjQlVBaOmJAVlaPW0XkVJJDhHQpElY4HU8AIUN5CGuVfEGN9/s5855p9xUZ+wkQhgMPPHiSiFwqIj8l6Yo0/ejNtbBrEKBZ3kpVXP3s3Mf/0Z7vvJ8AAIYPP6hABLeIOBcyvMC6NgEgJBR6k1r9r2fmPpGQNUjbs4KThQNKR5wnwmWkXNjZuiQCUq5xXOe5hNMnU5l0wrBhw3pQ3Fki8tvw2pxuFqApnoJ8UI3+7qnnH4nLV5K2R8W2ByUlJQ7o3E3S92bUJmxT1c0kdwLYpaF9jlus1QYhqERPgn0B9FDV3iQHAOiP1Fc0ErxYROYBeCuuhClSqEujuPiA/3Ac53YK2Vzj2rAAtQQeouhskYxKVQQFMBaO+frrT1pNKh04/AQOHmgFjuuKiGsMhrkZcpUjzoVCuimyAM3PGoJA/tNPP+T7wOp9kgDDDhheQbAoZK5bEwBgNcDbSLxLmmVlZWXtPv9/8uST81y4P6YjfxJyZIoIAFX91yeeefhxv3p1OAGOL+4juRm5fRXSG2CGUusCwcaa98trO8QPXlhYMsnNcD8gmtvrvQjQAPABx9GrysrKUrJWYMqU0/o4lEeF8pNUEIDkJ4/NfvAYv/p0GAGOKSzM7JWJ34GcTmlxGZOiTlWf21RXP/2Lqo0p3YFbXDzsJnGcayMRQBXXf//98j+nMn8AyMs7h+PHBN5wXDk12QQQEXjBYO6Tzz3iy22c8mHgpNL8/JOHF72Umy0bVeQ2JYutgnsFIFfJaf1yc2pOKi2cnkp9NNSBiwhr9fFU5t2M2toXlGJ/BiAll0uI6/bzHTcVCjTjhNLC0xy6Kyx5pgV6GYTmc6MFC+SAcucJpYVnpEonqnkF0dctHpKqfFvizbdf366qn6RCNkHfV+CmjAATSwqPBmW+BXsaBcKCGsUOz9gHg9abbLVxUDBgS4JqrzIKYwAoeUOq9KqoqFgKxQ+R3onI7SNHHpyZqrxbg3EN2fzD1zG3AFJIAHV4s1GwReHXG7XTrLFFH65e95uFq9Z/8P7KDbULK9ZVWM/eZtR+bkJHgE44sniwbzMWL6zaiKd7kxhNyj9HjBgRz0VRCYOavMuqw6GIeoReK6SEAEcXDB5qgckWivBgrPnNP1ete2zhmnWt9gt+VL5ejaK+Ka5DyJBU6AYAFeWrH1ToK5HekTjCzcheMWrUIWcedNBBCZ9l7AcKTEqNXOt7IUlKPIHWdcZTW5BL1XqN9ploaQ4rLMi04Jjm1jmg6uu+n5OGD5UMOjlUiLXB+rdWV/thv6r1/gXM/BpEq6NoCA6myEuk849DDhlzmaqpLisrS+pO4VOm/DibgsOSKRMAVDVQ18gtfuOnxAJYsK6F6YcBoW4gavtqiJFG0TcUX6sDa6tjnsQ5tbRweCbdN0gpg8hycTK/mDqi+HfwMbwtLy/fYq2eAEXUH4vkuaRT5jqZz4wePdrXqSd+QcrZAHydZRQf9M25cx/yPR+QEgI02MBio1pnEVqQ3xTESvb5keKPKy7oR+E8CzgWgFG8Wxalp96MU4YXn0xHPgI5FUARgKEgDxXynqkjij+ZOrzoyFh6rlnzwxprvUNUta2rZfsCvCDD7VE5btzhj40be8TUUaMOb1dH8ZQppx0t5ONIgR9GVZ+NJ37KHEFjigtfIHl2+DMFak3QO6ZsfdWq5meji/L7OHQeIXnu7niqZyytWBdtwylOHl7QW8RdAWBwGyoEDLypYuzCt1dVxdoIwgNHjnpTKFMYWskbazZwPYDbSHlJgE0Wsn3x4o9ibjaZMnlqH4pzloj8XSgZKfAEehYsefLpB32fY5wyAowuHjqZlPcivNqsaq8NqPdmJt0TAP4/kgc0v1TVD9TTk5evXx/RFXt8cTGzMvE+ST8dqACs/fnbK9fOixWxdOTILEedSx1Hbo9jOjhAcgvADUK+Q2KhUpYaU1/+2WefBUaPHi0Dew4cqllZx2Q4PI+USSQHSTPJkkwAqM564tm//8HH77IbKXUFH1RUcDfJy/zGV8Cq2sNXrF0f9Wyek4YVFjHD+QGAXzPcoKo/XfBDha8r3UeOPPhYx3FvI3lse9YDEDAUkdCEY8rXAwBkgzW2ePbzj9b6/F1C+cYTOV4EPXudtfqtVcBHMNbaS9sqfACAw2uhyIQCYaHOGnMmgma4qs6DQsPeZQN4YtKwolI/Oq9YsfzjYNBMUtU/qyKuHzMcJB103FyLVcXMeAsfSDEBVlVVbQ9anRi0ujGGG1iN2msUaPPyxRNKhuQq5eIWnUtYY65+b9W6V95ds26VWj3fWntH+HsFBziuvORX7x9+KDPLly+93lp7IBK80qYjodCFDd62mxNJm1JHBwBs3bGjvmdu7pMgBqniUAVlr8qrusJanba6cv1jm7e3vQWgeEC/g0m2PC+ounbV2p/XNo0a1mzZbov69fqIkB+BGBoWb1BJ395Dh/TNnl+5dZevMf3GjTWNNTXVL+UNyn+ZpENwDEkHTbuZWqwhaP2MPp8hgryI8SI++1SVZz43Z3ZCm0Y6dD1AQX7+UUL+K8hSBTZD9TXP2rnV1dW+VrROHF50jkPZq0Oniv/9cGV5qwspJxUXDGGmuwrYy90atNYcvnDVuoQOhRgz5vBhjsOZInKyUPI7e00gycXGBs98bu7shG8v6dA1gZVVVZ8CSPiSRSEPa1l1VfX9SHE/rKisnlha9DcRuSLscQYobx+en1+0uKoq7lU+S5cuXgPgV2PHTMh03Yx/EZE7SebEKycpUPtqQ9D52T9emN3QHjFptSzcWoxq1XkkonYa6fFaq1gbHl/BQZk93Avao8eSpV8Gvvjy04cDwfp+UExS1f8GUNEemX6hinJr7E+M1XP+8cJj7Sp8IM3WBB5XWryI5F4HQRuYCYtWrotKguNKi/9C8o/hzxSo9Iwd/ematb7mG/xg7NixTm5278kUOUtEDid5IEXykjQMDArwlSqfrwvqfa+99ky7C74ZabUs3AK9WzLWeLbNH6MRO/6Sob0uJxl+k0iBkL8GcHeydFuyZIkB8G5TAABMOu6kA63wQhGcTjpjEOp0s0VoCUXTAEZVN1H1vu317l1vvjk7JZtk08oCHF1a/D3JEeHPVM1hn6xa92WMdLNJ7r3zR1G2aFV5h60AmjJxSg91M/o5In0p7EUwh8IsQnoISQo9gg10WC+QLQBqGs3O2jfeeCOl5xWnlQVQoNWCUVUUAWiTAKp4GcTeBCBGH3lA0VmfrV7r2z/QHrz7z3frEbrSrkvdN5henUBgSysnEGR8zHTWe88C2jItyG5x+2d7kFYEUMVKVSA8gJwYK93n5etr1OqylmkVHI80awaTjfQiALBs7ykAQIFD/aS10M8ipO1z2LDCX6dI3bRAdyDA0HHDin4ROy3XR0gLpVwxqmDQPmsF0ooAVrGmdR8AoMhd4w8o6tlmWiA7UlolizPdrNzUat51kV4EgFehQE2EmjzQgnMPKS7sGyUpAZwY0QIAORb+L5vsbkj5bGAyUbN1hxnUp48FGOHuAI6gyKl5fXovzuvdZ0vt9u0eAJSUlLCwX++zSIl2kZWo8r2abdtWpFD1Lou0a/tGFxcNcBxZC0TdVBGAosaqLiBZDegxJI8Eot8prNb+dVn52n3mnqBwpJUjCADE2C2GfJfC06NEyQRRCPJXIRca215eDADk2GTqmE5Iqz4AACyrrLRBY/+vAr5vI4sFBfKSJSvdkHYEAIDv163bbI3eE6lXn1BQ/3vpuhvSkgAAUAfMsKovtvLuJRBAfNvZ36ezkLYEqKio8Dwb/DdrdVGU4Z3v4FlE3Ci6LyBtCQAAKyuqtjQAJ1qri9tBgEYC73WC+l0CaU0AAKioqGisa2g41lh7mQV2xtv+G7XzPGs3d472nY+0cgRFw45du+yWbds/7ZPbcy6FOUrmA4h1TzCgusCDnLtm7doufRNJKpF2jiA/GNG/v2tzcs5Tx7maZClC/o5msltVbYDqTasrKqLefbyvoFsSIBwlBQWOuK6rqkIAULVBY4Lr1q/ff3XcfuzH/wfoPFiLyqlaYQAAAABJRU5ErkJggg=="}},"servers":[],"tags":[{"name":"Admin","description":"Admin operations requiring authentication."},{"name":"Chat","description":"Endpoints related to the chat interface."},{"name":"Integrations","description":"APIs built to allow 3rd parties to interact with an Owncast server."}],"components":{"schemas":{"ClientArray":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"UserArray":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"LogEntryArray":{"type":"array","items":{"$ref":"#/components/schemas/LogEntry"}},"Client":{"type":"object","description":"A single representation of a client.","example":{"connectedAt":"2020-10-06T23:20:44.588649-07:00","messageCount":0,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36","ipAddress":"::1","clientID":"2ba20dd34f911c198df3218ddc64c740","geo":{"countryCode":"US","regionName":"California","timeZone":"America/Los_Angeles"}},"properties":{"connectedAt":{"type":"string","format":"date-time"},"messageCount":{"description":"Number of chat messages sent by user","type":"integer"},"userAgent":{"description":"The web client used to connect to this server","type":"string","example":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"},"ipAddress":{"description":"The public IP address of this client","type":"string"},"clientID":{"description":"The value used to identify this client","type":"string"},"geo":{"type":"object","description":"Optional geographic data for the client","properties":{"countryCode":{"type":"string"},"regionName":{"type":"string"},"timeZone":{"type":"string"}}},"user":{"$ref":"#/components/schemas/User"}},"x-last-modified":1602052347511},"BasicResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}},"InstanceDetails":{"type":"object","description":"User-facing details about this server.","properties":{"name":{"type":"string","description":"Displayed as the header in the instance details."},"summary":{"type":"string","description":"This is brief summary of whom you are or what the stream is."},"logo":{"type":"string","description":"Local file name of your logo image. We recommend a square image (150 x 150px) with ample padding around the important contents of the image, as it will be rendered as a circle."},"tags":{"type":"array","description":"Categories of the content this instance focuses on.","items":{"type":"string"}},"socialHandles":{"type":"array","description":"Links to social network urls.","items":{"type":"object","properties":{"platform":{"type":"string","example":"github"},"url":{"type":"string","example":"http://github.com/owncast/owncast"}}}},"extraPageContent":{"type":"string","description":"Additional HTML content to render in the body of the web interface.","example":"<p>This page is <strong>super</strong> cool!"},"version":{"type":"string","example":"Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"}}},"YP":{"type":"object","description":"Configuration of the instance's registration to the Owncast Directory (YP API)","properties":{"enabled":{"type":"boolean","description":"If YP support is on or off. Must be enabled to show in the directory.","default":false},"instanceUrl":{"type":"string","description":"The public URL of this owncast server, used for registration and linking with the directory. Must be publicly available."}}},"S3":{"type":"object","description":"Configuration of external storage using S3-compatible providers.","properties":{"enabled":{"type":"boolean"},"endpoint":{"type":"string"},"servingEndpoint":{"type":"string"},"accessKey":{"type":"string"},"secret":{"type":"string"},"bucket":{"type":"string"},"region":{"type":"string"},"acl":{"type":"string"}},"required":["enabled"]},"StreamQuality":{"type":"object","properties":{"videoPassthrough":{"type":"boolean","description":"If enabled video transcoding is disabled and the video is passed along in its original format."},"audioPassthrough":{"type":"boolean","description":"If enabled audio transcoding is disabled and the audio is passed along in its original format."},"videoBitrate":{"type":"integer","description":"The video quality, in kbps."},"audioBitrate":{"type":"integer","description":"The audio quality, in kbps."},"scaledWidth":{"type":"integer","description":"The resized video width."},"scaledHeight":{"type":"integer","description":"The resized video height."},"framerate":{"type":"integer","description":"The target frames per second of the video."},"cpuUsageLevel":{"type":"integer","description":"The amount of hardware utilization selected for this HLS variant."}}},"TimestampedValue":{"type":"object","properties":{"time":{"type":"string","format":"date-time"},"value":{"type":"integer"}}},"ConfigValue":{"description":"A wrapper object used to set values in many config endpoints.","type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"object"},{"type":"boolean"}]}}},"LogEntry":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"Timestamp for this log entry"},"level":{"type":"string","description":"The level of this log entry"},"message":{"type":"string","description":"The log entry contents"}}},"Webhook":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this webhook."},"url":{"type":"string","description":"The URL that events will be sent to."},"events":{"type":"array","items":{"type":"string","description":"The events that will be sent to this webhook."}},"timestamp":{"type":"string","format":"date-time","description":"When this webhook was created."},"lastUsed":{"type":"string","format":"date-time","description":"When this webhook was last used."}}},"User":{"type":"object","properties":{"id":{"type":"string","description":"User ID","example":"yklw5Imng"},"displayName":{"type":"string","description":"The user-facing disaplay name for this user.","example":"awesome-pizza"},"displayColor":{"type":"integer","description":"Hue value for displaying in the UI.","example":42},"createdAt":{"type":"string","format":"date-time","description":"When this account was originally registered/created."},"previousNames":{"type":"string","description":"Comma separated list of names previously used by this user.","example":"awesome-pizza,user42"}}}},"securitySchemes":{"AdminBasicAuth":{"type":"http","scheme":"basic","description":"The username for admin basic auth is `admin` and the password is the stream key."},"AccessToken":{"type":"http","scheme":"bearer","description":"3rd party integration auth where a service user must provide an access token."},"UserToken":{"type":"apiKey","name":"accessToken","in":"query","description":"3rd party integration auth where a service user must provide an access token."}},"responses":{"UsersResponse":{"description":"A collection of users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserArray"}}}},"ClientsResponse":{"description":"Successful response of an array of clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientArray"},"example":[{"connectedAt":"2020-10-06T23:20:44.588649-07:00","messageCount":3,"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36","ipAddress":"172.217.164.110","geo":{"countryCode":"US","regionName":"California","timeZone":"America/Los_Angeles"},"user":{"id":"yklw5Imng","displayName":"awesome-pizza","displayColor":42,"createdAt":"2021-07-08T20:21:25.303402404-07:00","previousNames":"awesome-pizza,coolPerson23"}}]}}},"LogsResponse":{"description":"Response of server log entries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogEntryArray"},"examples":{"success":{"summary":"Logs returned","value":[{"message":"Owncast v0.0.0-localdev (unknown)","level":"info","time":"2020-10-29T18:35:34.422386-07:00"},{"message":"Web server running on port: 8080","level":"info","time":"2020-10-29T18:35:35.011731-07:00"},{"message":"RTMP server is listening for incoming stream on port: 1935","level":"info","time":"2020-10-29T18:35:35.011823-07:00"}]}}}}},"BasicResponse":{"description":"Operation Success/Failure Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicResponse"},"examples":{"success":{"summary":"Operation succeeded.","value":{"success":true,"message":"context specific success message"}},"failure":{"summary":"Operation failed.","value":{"success":false,"message":"context specific failure message"}}}}}}}},"paths":{"/api/config":{"get":{"summary":"Information","description":"The client configuration. Information useful for the user interface.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstanceDetails"}}}}}}},"/api/ping":{"get":{"summary":"Mark the current viewer as active.","description":"For tracking viewer count, periodically hit the ping endpoint.","tags":["Server"],"responses":{"200":{"description":"Successful ping"}}}},"/api/status":{"get":{"summary":"Current Status","description":"This endpoint is used to discover when a server is broadcasting, the number of active viewers as well as other useful information for updating the user interface.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"lastConnectTime":{"type":"string","nullable":true,"format":"date-time"},"overallMaxViewerCount":{"type":"integer"},"sessionMaxViewerCount":{"type":"integer"},"online":{"type":"boolean"},"viewerCount":{"type":"integer"},"lastDisconnectTime":{"type":"string","nullable":true,"format":"date-time"}}},"examples":{"online":{"value":{"lastConnectTime":"2020-10-03T21:36:22-05:00","lastDisconnectTime":null,"online":true,"overallMaxViewerCount":420,"sessionMaxViewerCount":12,"viewerCount":7}}}}}}}}},"/api/chat/register":{"post":{"summary":"Register a chat user","description":"Register a user that returns an access token for accessing chat.","tags":["Chat"],"security":[{"UserToken":[]}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":"Optionally provide a display name you want to assign to this user when registering."}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The new user's id."},"accessToken":{"type":"string","description":"The access token used for accessing chat."},"displayName":{"type":"string","description":"The user-facing name displayed for this user."}}}}}}}}},"/api/chat":{"get":{"summary":"Chat Messages Backlog","description":"Used to get chat messages prior to connecting to the websocket.","tags":["Chat"],"security":[{"UserToken":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/yp":{"get":{"summary":"Yellow Pages Information","description":"Information to be used in the Yellow Pages service, a global directory of Owncast servers.","tags":["Server"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"logo":{"type":"string"},"nsfw":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"online":{"type":"boolean"},"viewerCount":{"type":"integer"},"overallMaxViewerCount":{"type":"integer"},"sessionMaxViewerCount":{"type":"integer"},"lastConnectTime":{"type":"string","nullable":true,"format":"date-time"}}}}}}}}},"/api/emoji":{"get":{"summary":"Get Custom Emoji","description":"Get a list of custom emoji that are supported in chat.","tags":["Chat"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Emoji"},"emoji":{"type":"string","description":"The relative path to the Emoji image file"}}}},"examples":{"default":{"value":{"items":[{"name":"nicolas_cage_party","emoji":"/img/emoji/nicolas_cage_party.gif"},{"name":"parrot","emoji":"/img/emoji/parrot.gif"}]}}}}}}}}},"/api/admin/status":{"get":{"summary":"Server status and broadcaster","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Server status and broadcaster details","content":{"application/json":{"schema":{"type":"object","properties":{"broadcaster":{"type":"object","properties":{"remoteAddr":{"type":"string"},"time":{"type":"string","format":"date-time"},"streamDetails":{"type":"object","properties":{"width":{"type":"integer"},"height":{"type":"integer"},"frameRate":{"type":"integer"},"videoBitrate":{"type":"integer"},"videoCodec":{"type":"string"},"audioBitrate":{"type":"integer"},"audioCodec":{"type":"string"},"encoder":{"type":"string"}}}}},"online":{"type":"boolean","description":"Is a stream currently active"},"viewerCount":{"type":"integer","description":"The current number of viewers"},"sessionPeakViewerCount":{"type":"integer","description":"The peak number of viewers this streaming session"},"overallPeakViewerCount":{"type":"integer","description":"The all-time peak number of viewers"},"versionNumber":{"type":"string","description":"The current version of the owncast software"}}},"examples":{"connected":{"summary":"Broadcaster Connected","value":{"broadcaster":{"remoteAddr":"172.217.164.110","time":"2020-10-06T23:20:44.588649-07:00","streamDetails":{"width":640,"height":480,"frameRate":24,"videoBitrate":1500,"videoCodec":"mp4a","audioBitrate":256,"audioCodec":"aac","encoder":"obs-output module (libobs version 25.0.8)"}},"online":true,"viewerCount":3,"overallPeakViewerCount":4,"sessionPeakViewerCount":4,"versionNumber":"0.0.3"}}}}}}}}},"/api/admin/disconnect":{"post":{"summary":"Disconnect Broadcaster","description":"Disconnect the active inbound stream, if one exists, and terminate the broadcast.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/yp/reset":{"post":{"summary":"Reset your YP registration key.","description":"Used when there is a problem with your registration to the Owncast Directory via the YP APIs. This will reset your local registration key.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/chat/clients":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/ClientsResponse"}}}},"/api/admin/users/disabled":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/UsersResponse"}}}},"/api/admin/logs":{"get":{"summary":"Return recent log entries","description":"Returns server logs.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/LogsResponse"}}}},"/api/admin/logs/warnings":{"get":{"summary":"Return recent warning and error logs.","description":"Return recent warning and error logs.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/LogsResponse"}}}},"/api/admin/serverconfig":{"get":{"summary":"Server Configuration","description":"Get the current configuration of the Owncast server.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"instanceDetails":{"$ref":"#/components/schemas/InstanceDetails"},"ffmpegPath":{"type":"string","description":"The path to the copy of ffmpeg that this server is using."},"webServerPort":{"type":"integer","description":"The port the public web server is listening on."},"rtmpServerPort":{"type":"integer","description":"The port the inbound RTMP broadcast should be sent to."},"s3":{"$ref":"#/components/schemas/S3"},"videoSettings":{"type":"object","description":"How the different variants of video streams are configured.","properties":{"videoQualityVariants":{"type":"array","items":{"$ref":"#/components/schemas/StreamQuality"}},"latencyLevel":{"type":"integer","description":"The level of latency selected for streaming. Lower latency can create more buffering."}}},"yp":{"$ref":"#/components/schemas/YP"}}}}}}}}},"/api/admin/chat/messages":{"get":{"summary":"Chat messages, unfiltered.","description":"Get a list of all chat messages with no filters applied.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/admin/chat/updatemessagevisibility":{"post":{"summary":"Update the visibility of chat messages.","description":"Pass an array of IDs you want to change the chat visibility of.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"visible":{"type":"boolean","description":"Are these messages visible."},"idArray":{"type":"array","items":{"type":"string","description":"IDs of the chat messages you wish to change the visibility of."}}}}}}},"tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/chat/users/setenabled":{"post":{"summary":"Enable or disable a single user.","description":"Enable or disable a single user. Disabling will also hide all the user's chat messages.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID to act upon.","example":"yklw5Imng"},"enabled":{"type":"boolean","description":"Set the enabled state of this user."}}}}}},"tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}},"/api/admin/config/key":{"post":{"summary":"Set the stream key.","description":"Set the stream key. Also used as the admin password.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"}}}}}},"/api/admin/config/pagecontent":{"post":{"summary":"Set the custom page content.","description":"Set the custom page content using markdown.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":"# Welcome to my cool server!<br><br>I _hope_ you enjoy it."}}}}},"/api/admin/config/streamtitle":{"post":{"summary":"Set the stream title.","description":"Set the title of the currently streaming content.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"Streaming my favorite game, Desert Bus."}}}}}},"/api/admin/config/name":{"post":{"summary":"Set the server name.","description":"Set the name associated with your server. Often is your name, username or identity.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"}}}}}},"/api/admin/config/serversummary":{"post":{"summary":"Set the server summary.","description":"Set the summary of your server's streaming content.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"The best in Desert Bus Streaming"}}}}}},"/api/admin/config/logo":{"post":{"summary":"Set the server logo.","description":"Set the logo for your server. Path is relative to webroot.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"/img/mylogo.png"}}}}}},"/api/admin/config/tags":{"post":{"summary":"Set the server tags.","description":"Set the tags displayed for your server and the categories you can show up in on the directory.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":["games","music","streaming"]}}}}}},"/api/admin/config/ffmpegpath":{"post":{"summary":"Set the ffmpeg binary path","description":"Set the path for a specific copy of ffmpeg on your system.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"/home/owncast/ffmpeg"}}}}}},"/api/admin/config/webserverport":{"post":{"summary":"Set the owncast web port.","description":"Set the port the owncast web server should listen on.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":8080}}}}}},"/api/admin/config/rtmpserverport":{"post":{"summary":"Set the inbound rtmp server port.","description":"Set the port where owncast service will listen for inbound broadcasts.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":1935}}}}}},"/api/admin/config/nsfw":{"post":{"summary":"Mark if your stream is not safe for work","description":"Mark if your stream can be consitered not safe for work. Used in different contexts, including the directory for filtering purposes.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":false}}}}}},"/api/admin/config/directoryenabled":{"post":{"summary":"Set if this server supports the Owncast directory.","description":"If set to true the server will attempt to register itself with the [Owncast Directory](https://directory.owncast.online). Off by default.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":true}}}}}},"/api/admin/config/serverurl":{"post":{"summary":"Set the public url of this owncast server.","description":"Set the public url of this owncast server. Used for the directory and optional integrations.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"https://live.mycoolserver.biz"}}}}}},"/api/admin/config/video/streamlatencylevel":{"post":{"summary":"Set the latency level for the stream.","description":"Sets the latency level that determines how much video is buffered between the server and viewer. Less latency can end up with more buffering.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The latency level","type":"integer"}},"example":{"value":4}}}}}}},"/api/admin/config/video/streamoutputvariants":{"post":{"summary":"Set the configuration of your stream output.","description":"Sets the detailed configuration for all of the stream variants you support.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":[{"framerate":30,"videoPassthrough":false,"videoBitrate":1800,"cpuUsageLevel":2,"audioPassthrough":true},{"framerate":24,"videoPassthrough":false,"videoBitrate":1000,"cpuUsageLevel":3,"audioPassthrough":true}]}}}}}},"/api/admin/config/video/codec":{"post":{"summary":"Set the video codec.","description":"Sets the specific video codec that will be used for video encoding. Some codecs will support hardware acceleration. Not all codecs will be supported for all systems.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The video codec to change to.","type":"string"}},"example":{"value":"libx264"}}}}}}},"/api/admin/config/s3":{"post":{"summary":"Set your storage configration.","description":"Sets your S3 storage provider configuration details to enable external storage.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":{"enabled":true,"endpoint":"https://s3.us-west-000.backblazeb2.com","accessKey":"e1ac500y7000500047156bd060","secret":"H8FH8eSxM2K/S42CUg5K000Tt4WY2fI","bucket":"video","region":"us-west-000"}}}}}}},"/api/admin/config/socialhandles":{"post":{"summary":"Set your social handles.","description":"Sets the external links to social networks and profiles.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":[{"platform":"github","url":"https://github.com/owncast/owncast"},{"platform":"mastodon","url":"https://mastodon.social/@gabek"}]}}}}}},"/api/admin/config/customstyles":{"post":{"summary":"Custom CSS styles to be used in the web front endpoints.","description":"Save a string containing CSS to be inserted in to the web frontend page.","tags":["Admin"],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"body { color: orange; background: black; }"}}}}}},"/api/admin/viewersOverTime":{"get":{"summary":"Viewers Over Time","description":"Get the tracked viewer count over the collected period.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"examples":{"default":{"value":[{"time":"2020-10-03T21:41:00.381996-05:00","value":50},{"time":"2020-10-03T21:42:00.381996-05:00","value":52}]}}}}}}}},"/api/admin/hardwarestats":{"get":{"summary":"Hardware Stats","description":"Get the CPU, Memory and Disk utilization levels over the collected period.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"cpu":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"memory":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}},"disk":{"type":"array","items":{"$ref":"#/components/schemas/TimestampedValue"}}}},"examples":{"default":{"value":{"cpu":[{"time":"2020-10-03T21:41:00.381996-05:00","value":23},{"time":"2020-10-03T21:42:00.381996-05:00","value":27},{"time":"2020-10-03T21:43:00.381996-05:00","value":22}],"memory":[{"time":"2020-10-03T21:41:00.381996-05:00","value":65},{"time":"2020-10-03T21:42:00.381996-05:00","value":66},{"time":"2020-10-03T21:43:00.381996-05:00","value":72}],"disk":[{"time":"2020-10-03T21:41:00.381996-05:00","value":11},{"time":"2020-10-03T21:42:00.381996-05:00","value":11},{"time":"2020-10-03T21:43:00.381996-05:00","value":11}]}}}}}}}}},"/api/integrations/streamtitle":{"post":{"summary":"Set the stream title.","description":"Set the title of the currently streaming content.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigValue"},"example":{"value":"Streaming my favorite game, Desert Bus."}}}}}},"/api/integrations/chat/send":{"post":{"summary":"Send a chat message.","description":"Send a chat message on behalf of a 3rd party integration, bot or service.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The message text that will be sent as the user."}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/system":{"post":{"summary":"Send a system chat message.","description":"Send a chat message on behalf of the system/server.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The message text that will be sent as the system user."}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/action":{"post":{"summary":"Send a chat action.","description":"Send an action that took place to the chat.","tags":["Integrations"],"security":[{"AccessToken":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message text that will be sent as the system user.","example":"rolled a 15 on the dice"},"author":{"type":"string","description":"An optional user name that performed the action.","example":"JohnSmith"}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"sent"}}}}}}}}},"/api/integrations/chat/system/client/{clientId}":{"post":{"summary":"Send system chat message to a client, identified by its ClientId","description":"Send a chat message on behalf of the system/server to a single client.","tags":["Integrations"],"security":[{"AccessToken":[]}],"parameters":[{"name":"clientId","in":"path","description":"Client ID (a unique numeric Id, identifying the client connection)","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message text that will be sent to the client.","example":"What a beautiful day. I love it"}}}}}},"responses":{"200":{"description":"Message was sent.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"messages":{"type":"string","example":"sent"}}}}}},"500":{"description":"Message was not sent to the client","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"message explaining what went wrong sending the message to the client"}}}}}}}}},"/api/admin/accesstokens/create":{"post":{"summary":"Create an access token.","description":"Create a single access token that has access to the access scopes provided.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The human-readable name to give this access token."},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Token was created.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"your new token"},"token":{"type":"string","example":"zG2xO-mHTFnelCp5xaIkYEFWcPhoOswOSRmFC1BkI="}}}}}}}}},"/api/admin/accesstokens/delete":{"post":{"summary":"Delete an access token.","description":"Delete a single access token.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"The token to delete"}}}}}},"responses":{"200":{"description":"Token was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"message":{"type":"string","example":"deleted token"}}}}}}}}},"/api/admin/accesstokens":{"get":{"summary":"Return all access tokens.","description":"Return all of the available access tokens.","tags":["Integrations"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Tokens are returned","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/admin/webhooks":{"get":{"summary":"Return all webhooks.","description":"Return all of the configured webhooks for external events.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"responses":{"200":{"description":"Webhooks are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}}}}},"/api/admin/config/externalactions":{"post":{"summary":"Set external action URLs.","description":"Set a collection of external action URLs that are displayed in the UI.","tags":["Admin","Integrations"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL of the external action content."},"title":{"type":"string","description":"The title to put on the external action button."},"description":{"type":"string","description":"Optional additional description to display in the UI."},"icon":{"type":"string","description":"The URL to an image to place on the external action button."},"color":{"type":"string","description":"Optional color to use for drawing the action button."},"openExternally":{"type":"boolean","description":"If set this action will open in a new browser tab instead of an internal modal."}}}}}}},"responses":{"200":{"description":"Actions have been updated."}}}},"/api/admin/webhooks/delete":{"post":{"summary":"Delete a single webhook.","description":"Delete a single webhook by its ID.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The webhook id to delete"}}}}}},"responses":{"200":{"description":"Webhook is deleted"}}}},"/api/admin/webhooks/create":{"post":{"summary":"Create a webhook.","description":"Create a single webhook that acts on the requested events.","tags":["Admin"],"security":[{"AdminBasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The url to post the events to."},"events":{"description":"The events to be notified about.","type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Token was created.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"your new token"},"token":{"type":"string","example":"zG2xO-mHTFnelCp5xaIkYEFWcPhoOswOSRmFC1BkI="}}}}}}}}},"/api/integrations/clients":{"get":{"summary":"Return a list of currently connected clients","description":"Return a list of currently connected clients with optional geo details.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/ClientsResponse"}}}},"/api/integrations/chat":{"get":{"summary":"Historical Chat Messages","description":"Used to get the backlog of chat messages.","tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"body":{"type":"string","description":"Escaped HTML of the chat message content."},"id":{"type":"string","description":"Unique ID of the chat message."},"visible":{"type":"boolean","description":"Should chat message be visibly rendered."},"timestamp":{"type":"string","format":"date-time"}}}}}}}}}},"/api/integrations/chat/updatemessagevisibility":{"post":{"summary":"Update the visibility of chat messages.","description":"Pass an array of IDs you want to change the chat visibility of.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"visible":{"type":"boolean","description":"Are these messages visible."},"idArray":{"type":"array","items":{"type":"string","description":"IDs of the chat messages you wish to change the visibility of."}}}}}}},"tags":["Integrations"],"security":[{"AccessToken":[]}],"responses":{"200":{"$ref":"#/components/responses/BasicResponse"}}}}}}},"searchIndex":{"store":["section/Authentication","tag/Admin","tag/Admin/paths/~1api~1admin~1status/get","tag/Admin/paths/~1api~1admin~1disconnect/post","tag/Admin/paths/~1api~1admin~1yp~1reset/post","tag/Admin/paths/~1api~1admin~1chat~1clients/get","tag/Admin/paths/~1api~1admin~1users~1disabled/get","tag/Admin/paths/~1api~1admin~1logs/get","tag/Admin/paths/~1api~1admin~1logs~1warnings/get","tag/Admin/paths/~1api~1admin~1serverconfig/get","tag/Admin/paths/~1api~1admin~1chat~1messages/get","tag/Admin/paths/~1api~1admin~1chat~1updatemessagevisibility/post","tag/Admin/paths/~1api~1admin~1chat~1users~1setenabled/post","tag/Admin/paths/~1api~1admin~1config~1key/post","tag/Admin/paths/~1api~1admin~1config~1pagecontent/post","tag/Admin/paths/~1api~1admin~1config~1streamtitle/post","tag/Admin/paths/~1api~1admin~1config~1name/post","tag/Admin/paths/~1api~1admin~1config~1serversummary/post","tag/Admin/paths/~1api~1admin~1config~1logo/post","tag/Admin/paths/~1api~1admin~1config~1tags/post","tag/Admin/paths/~1api~1admin~1config~1ffmpegpath/post","tag/Admin/paths/~1api~1admin~1config~1webserverport/post","tag/Admin/paths/~1api~1admin~1config~1rtmpserverport/post","tag/Admin/paths/~1api~1admin~1config~1nsfw/post","tag/Admin/paths/~1api~1admin~1config~1directoryenabled/post","tag/Admin/paths/~1api~1admin~1config~1serverurl/post","tag/Admin/paths/~1api~1admin~1config~1video~1streamlatencylevel/post","tag/Admin/paths/~1api~1admin~1config~1video~1streamoutputvariants/post","tag/Admin/paths/~1api~1admin~1config~1video~1codec/post","tag/Admin/paths/~1api~1admin~1config~1s3/post","tag/Admin/paths/~1api~1admin~1config~1socialhandles/post","tag/Admin/paths/~1api~1admin~1config~1customstyles/post","tag/Admin/paths/~1api~1admin~1viewersOverTime/get","tag/Admin/paths/~1api~1admin~1hardwarestats/get","tag/Admin/paths/~1api~1admin~1webhooks/get","tag/Admin/paths/~1api~1admin~1config~1externalactions/post","tag/Admin/paths/~1api~1admin~1webhooks~1delete/post","tag/Admin/paths/~1api~1admin~1webhooks~1create/post","tag/Chat","tag/Chat/paths/~1api~1chat~1register/post","tag/Chat/paths/~1api~1chat/get","tag/Chat/paths/~1api~1emoji/get","tag/Integrations","tag/Integrations/paths/~1api~1integrations~1streamtitle/post","tag/Integrations/paths/~1api~1integrations~1chat~1send/post","tag/Integrations/paths/~1api~1integrations~1chat~1system/post","tag/Integrations/paths/~1api~1integrations~1chat~1action/post","tag/Integrations/paths/~1api~1integrations~1chat~1system~1client~1{clientId}/post","tag/Integrations/paths/~1api~1admin~1accesstokens~1create/post","tag/Integrations/paths/~1api~1admin~1accesstokens~1delete/post","tag/Integrations/paths/~1api~1admin~1accesstokens/get","tag/Integrations/paths/~1api~1admin~1config~1externalactions/post","tag/Integrations/paths/~1api~1integrations~1clients/get","tag/Integrations/paths/~1api~1integrations~1chat/get","tag/Integrations/paths/~1api~1integrations~1chat~1updatemessagevisibility/post","tag/Server","tag/Server/paths/~1api~1config/get","tag/Server/paths/~1api~1ping/get","tag/Server/paths/~1api~1status/get","tag/Server/paths/~1api~1yp/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.469]],["description/0",[1,5.749,2,4.44,3,4.44]],["title/1",[4,3.998]],["description/1",[0,3.828,4,3.425,5,4.44,6,4.44]],["title/2",[7,1.036,8,3.318,9,2.499]],["description/2",[]],["title/3",[9,2.868,10,3.808]],["description/3",[9,2.232,10,2.963,11,2.651,12,2.651,13,1.399,14,3.437,15,3.437,16,3.437]],["title/4",[17,2.94,18,2.94,19,2.94,20,2.399]],["description/4",[17,2.417,18,2.417,19,3.597,20,1.972,21,1.199,22,2.803,23,1.262,24,1.694,25,2.803,26,2.417,27,2.803]],["title/5",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/5",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/6",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/6",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/7",[28,1.261,36,2.63,37,2.399,38,3.41]],["description/7",[7,1.289,28,1.771,37,3.37]],["title/8",[28,1.132,36,2.361,37,2.153,39,2.639,40,2.639]],["description/8",[28,1.53,36,3.192,37,2.911,39,3.568,40,3.568]],["title/9",[7,1.189,41,2.499]],["description/9",[7,1.195,23,1.999,30,1.999,41,2.512]],["title/10",[42,0.947,43,1.423,44,3.849]],["description/10",[29,2.201,42,1.019,43,1.53,45,3.568,46,4.138]],["title/11",[42,0.839,43,1.261,47,2.63,48,2.399]],["description/11",[42,0.897,48,2.563,49,3.14,50,3.14,51,2.81,52,3.14,53,3.14]],["title/12",[54,2.63,55,2.94,56,1.813,57,2.06]],["description/12",[42,0.801,43,1.203,54,2.509,55,4.009,56,1.73,57,1.966,58,3.253,59,3.253]],["title/13",[13,1.566,20,2.707,60,0.425]],["description/13",[4,2.989,13,1.577,20,2.726,21,1.657,60,0.428,61,3.875]],["title/14",[60,0.377,62,2.214,63,2.214,64,2.214]],["description/14",[21,1.657,60,0.428,62,2.516,63,2.516,64,2.516,65,3.875]],["title/15",[13,1.566,60,0.425,66,2.707]],["description/15",[13,1.684,30,1.863,60,0.457,64,2.687,66,2.911]],["title/16",[7,1.036,60,0.425,67,3.318]],["description/16",[7,0.98,60,0.403,67,4.341,68,3.643,69,3.643,70,3.643]],["title/17",[7,1.036,60,0.425,71,3.318]],["description/17",[13,1.684,60,0.457,64,2.687,71,3.568,72,4.138]],["title/18",[7,1.036,60,0.425,73,3.318]],["description/18",[7,1.043,60,0.428,73,3.34,74,2.989,75,3.875,76,3.875]],["title/19",[7,1.036,60,0.425,77,3.318]],["description/19",[7,0.925,24,2.077,60,0.38,77,2.963,78,2.651,79,3.437,80,3.437,81,2.963]],["title/20",[60,0.377,74,2.63,82,2.94,83,3.41]],["description/20",[60,0.428,74,2.989,82,3.34,84,3.34,85,3.875,86,2.726]],["title/21",[23,1.535,60,0.377,87,2.399,88,2.399]],["description/21",[7,1.043,23,1.745,60,0.428,87,2.726,88,2.726,89,3.34]],["title/22",[7,0.824,12,2.361,60,0.338,88,2.153,90,3.06]],["description/22",[9,2.365,12,2.81,23,1.64,60,0.403,88,2.563,89,3.14,91,2.81]],["title/23",[13,1.388,92,2.63,93,2.94,94,2.94]],["description/23",[13,1.141,21,1.199,24,1.694,45,2.417,92,2.162,93,2.417,94,2.417,95,2.803,96,2.803,97,2.803,98,2.803,99,2.803]],["title/24",[7,0.824,23,1.378,24,1.849,60,0.338,100,2.153]],["description/24",[7,0.876,23,1.465,60,0.36,101,3.253,102,3.253,103,2.509,104,3.253,105,3.253,106,3.253]],["title/25",[7,0.824,23,1.378,60,0.338,107,2.639,108,1.849]],["description/25",[7,0.876,21,1.392,23,1.465,24,1.966,33,2.289,60,0.36,107,2.805,108,1.966,109,2.509]],["title/26",[13,1.388,60,0.377,110,2.94,111,2.63]],["description/26",[7,0.637,60,0.262,81,2.041,110,3.163,111,1.826,112,2.367,113,2.367,114,1.826,115,3.669,116,2.367,117,1.43,118,2.367,119,2.367,120,2.367]],["title/27",[13,1.388,41,1.929,60,0.377,121,3.41]],["description/27",[13,1.577,35,2.516,41,2.192,60,0.428,100,2.726,122,3.875]],["title/28",[60,0.425,114,2.969,123,3.318]],["description/28",[21,1.098,60,0.284,84,2.213,86,1.806,100,2.747,114,3.011,123,4.074,124,2.567,125,2.213,126,2.567]],["title/29",[60,0.425,127,3.318,128,3.849]],["description/29",[35,2.112,41,1.84,54,2.509,60,0.36,127,4.009,129,3.253,130,2.805,131,1.84]],["title/30",[60,0.425,132,3.318,133,3.849]],["description/30",[60,0.428,131,2.192,132,3.34,134,3.875,135,3.875,136,3.875]],["title/31",[21,1.087,62,1.65,87,1.787,137,2.19,138,2.54,139,2.54,140,1.787]],["description/31",[63,2.232,87,2.418,137,2.963,141,3.437,142,3.437,143,3.437,144,3.437,145,3.437]],["title/32",[117,2.326,146,2.969,147,3.849]],["description/32",[117,2.341,146,2.989,148,3.34,149,3.34,150,2.726,151,2.989]],["title/33",[125,3.808,152,4.417]],["description/33",[111,2.651,146,2.651,150,2.418,151,2.651,153,3.437,154,3.437,155,3.437,156,3.437]],["title/34",[28,1.633,157,2.669]],["description/34",[28,1.53,41,2.341,131,2.341,157,2.501,158,3.568]],["title/35",[60,0.377,108,2.06,131,1.929,159,2.06]],["description/35",[60,0.403,78,2.81,108,2.201,131,2.06,150,2.563,159,2.201,160,3.14]],["title/36",[56,2.047,157,2.326,161,2.707]],["description/36",[51,3.425,56,2.362,157,2.683,161,3.124]],["title/37",[157,2.669,162,3.108]],["description/37",[56,2.061,157,2.341,158,3.34,162,2.726,163,3.875,164,3.875]],["title/38",[42,1.276]],["description/38",[42,1.093,140,3.124,165,4.44,166,3.425]],["title/39",[42,0.947,57,2.326,103,2.969]],["description/39",[28,1.347,42,0.897,57,2.201,103,2.81,167,2.848,168,2.06]],["title/40",[42,0.947,43,1.423,169,3.318]],["description/40",[21,1.657,31,2.192,42,0.954,43,1.433,170,3.875,171,3.875]],["title/41",[62,2.868,172,3.808]],["description/41",[29,2.201,42,1.019,62,2.687,100,2.911,172,3.568]],["title/42",[109,3.998]],["description/42",[7,0.925,23,1.548,26,2.963,173,3.437,174,3.437,175,2.963,176,2.963,177,3.437]],["title/43",[13,1.566,60,0.425,66,2.707]],["description/43",[13,1.684,30,1.863,60,0.457,64,2.687,66,2.911]],["title/44",[42,0.947,43,1.423,178,2.047]],["description/44",[42,0.801,43,1.203,91,2.509,109,2.509,175,2.805,176,2.805,178,1.73,179,2.509,180,3.253]],["title/45",[42,0.839,43,1.261,86,2.399,178,1.813]],["description/45",[42,1.019,43,1.53,178,2.201,179,3.192,181,3.568]],["title/46",[42,0.947,159,2.326,178,2.047]],["description/46",[42,1.019,159,2.501,178,2.201,182,4.138,183,4.138]],["title/47",[32,1.275,42,0.625,43,0.939,86,1.787,178,1.351,184,2.54,185,2.54]],["description/47",[32,1.828,42,0.897,43,1.347,56,1.937,178,1.937,179,2.81,181,3.14]],["title/48",[162,2.707,167,2.177,168,2.177]],["description/48",[56,1.828,130,2.963,162,2.418,167,3.164,168,1.944,186,3.437]],["title/49",[161,2.707,167,2.177,168,2.177]],["description/49",[56,2.362,161,3.124,167,2.512,168,2.512]],["title/50",[28,1.423,167,2.177,168,2.177]],["description/50",[28,1.642,167,2.512,168,2.512,187,4.44]],["title/51",[60,0.377,108,2.06,131,1.929,159,2.06]],["description/51",[60,0.403,78,2.81,108,2.201,131,2.06,150,2.563,159,2.201,160,3.14]],["title/52",[28,1.132,29,1.628,30,1.378,31,1.731,32,1.536]],["description/52",[28,1.271,29,1.828,30,1.548,31,1.944,32,1.725,33,2.418,34,2.651,35,2.232]],["title/53",[42,0.947,43,1.423,188,3.849]],["description/53",[21,1.899,42,1.093,43,1.642,169,3.828]],["title/54",[42,0.839,43,1.261,47,2.63,48,2.399]],["description/54",[42,0.897,48,2.563,49,3.14,50,3.14,51,2.81,52,3.14,53,3.14]],["title/55",[7,1.395]],["description/55",[]],["title/56",[189,3.366]],["description/56",[21,1.657,32,1.944,41,2.192,57,2.341,166,2.989,189,2.516]],["title/57",[11,2.63,30,1.535,92,2.63,117,2.06]],["description/57",[117,2.201,140,2.563,148,3.14,149,3.14,151,2.81,190,3.643,191,3.643]],["title/58",[8,3.808,30,1.989]],["description/58",[7,0.691,9,1.667,11,1.98,21,1.67,47,1.98,57,1.551,117,1.551,140,1.806,166,1.98,189,1.667,192,2.567,193,2.567,194,2.567]],["title/59",[63,2.499,189,2.499,195,3.318]],["description/59",[7,0.876,21,1.392,23,1.465,24,1.966,63,2.112,91,2.509,189,2.112,195,2.805,196,3.253]]],"invertedIndex":[["",{"_index":1,"title":{},"description":{"0":{}}}],["3rd",{"_index":175,"title":{},"description":{"42":{},"44":{}}}],["acceler",{"_index":126,"title":{},"description":{"28":{}}}],["access",{"_index":167,"title":{"48":{},"49":{},"50":{}},"description":{"39":{},"48":{},"49":{},"50":{}}}],["act",{"_index":163,"title":{},"description":{"37":{}}}],["action",{"_index":159,"title":{"35":{},"46":{},"51":{}},"description":{"35":{},"46":{},"51":{}}}],["activ",{"_index":11,"title":{"57":{}},"description":{"3":{},"58":{}}}],["admin",{"_index":4,"title":{"1":{}},"description":{"1":{},"13":{}}}],["allow",{"_index":174,"title":{},"description":{"42":{}}}],["api",{"_index":26,"title":{},"description":{"4":{},"42":{}}}],["appli",{"_index":46,"title":{},"description":{"10":{}}}],["array",{"_index":50,"title":{},"description":{"11":{},"54":{}}}],["associ",{"_index":68,"title":{},"description":{"16":{}}}],["attempt",{"_index":102,"title":{},"description":{"24":{}}}],["authent",{"_index":0,"title":{"0":{}},"description":{"1":{}}}],["avail",{"_index":187,"title":{},"description":{"50":{}}}],["backlog",{"_index":169,"title":{"40":{}},"description":{"53":{}}}],["behalf",{"_index":179,"title":{},"description":{"44":{},"45":{},"47":{}}}],["between",{"_index":116,"title":{},"description":{"26":{}}}],["binari",{"_index":83,"title":{"20":{}},"description":{}}],["bot",{"_index":180,"title":{},"description":{"44":{}}}],["broadcast",{"_index":9,"title":{"2":{},"3":{}},"description":{"3":{},"22":{},"58":{}}}],["buffer",{"_index":115,"title":{},"description":{"26":{}}}],["built",{"_index":173,"title":{},"description":{"42":{}}}],["categori",{"_index":79,"title":{},"description":{"19":{}}}],["chang",{"_index":53,"title":{},"description":{"11":{},"54":{}}}],["chat",{"_index":42,"title":{"10":{},"11":{},"38":{},"39":{},"40":{},"44":{},"45":{},"46":{},"47":{},"53":{},"54":{}},"description":{"10":{},"11":{},"12":{},"38":{},"39":{},"40":{},"41":{},"44":{},"45":{},"46":{},"47":{},"53":{},"54":{}}}],["client",{"_index":32,"title":{"5":{},"6":{},"47":{},"52":{}},"description":{"5":{},"6":{},"47":{},"52":{},"56":{}}}],["clientid",{"_index":185,"title":{"47":{}},"description":{}}],["codec",{"_index":123,"title":{"28":{}},"description":{"28":{}}}],["collect",{"_index":150,"title":{},"description":{"32":{},"33":{},"35":{},"51":{}}}],["configr",{"_index":128,"title":{"29":{}},"description":{}}],["configur",{"_index":41,"title":{"9":{},"27":{}},"description":{"9":{},"27":{},"29":{},"34":{},"56":{}}}],["connect",{"_index":31,"title":{"5":{},"6":{},"52":{}},"description":{"5":{},"6":{},"40":{},"52":{}}}],["consit",{"_index":95,"title":{},"description":{"23":{}}}],["contain",{"_index":143,"title":{},"description":{"31":{}}}],["content",{"_index":64,"title":{"14":{}},"description":{"14":{},"15":{},"17":{},"43":{}}}],["context",{"_index":97,"title":{},"description":{"23":{}}}],["copi",{"_index":85,"title":{},"description":{"20":{}}}],["count",{"_index":149,"title":{},"description":{"32":{},"57":{}}}],["cpu",{"_index":153,"title":{},"description":{"33":{}}}],["creat",{"_index":162,"title":{"37":{},"48":{}},"description":{"37":{},"48":{}}}],["css",{"_index":137,"title":{"31":{}},"description":{"31":{}}}],["current",{"_index":30,"title":{"5":{},"6":{},"52":{},"57":{},"58":{}},"description":{"5":{},"6":{},"9":{},"15":{},"43":{},"52":{}}}],["custom",{"_index":62,"title":{"14":{},"31":{},"41":{}},"description":{"14":{},"41":{}}}],["default",{"_index":106,"title":{},"description":{"24":{}}}],["delet",{"_index":161,"title":{"36":{},"49":{}},"description":{"36":{},"49":{}}}],["detail",{"_index":35,"title":{},"description":{"5":{},"6":{},"27":{},"29":{},"52":{}}}],["determin",{"_index":112,"title":{},"description":{"26":{}}}],["differ",{"_index":96,"title":{},"description":{"23":{}}}],["directori",{"_index":24,"title":{"24":{}},"description":{"4":{},"19":{},"23":{},"25":{},"59":{}}}],["directory](https://directory.owncast.onlin",{"_index":105,"title":{},"description":{"24":{}}}],["disabl",{"_index":55,"title":{"12":{}},"description":{"12":{}}}],["disconnect",{"_index":10,"title":{"3":{}},"description":{"3":{}}}],["discov",{"_index":192,"title":{},"description":{"58":{}}}],["disk",{"_index":155,"title":{},"description":{"33":{}}}],["display",{"_index":78,"title":{},"description":{"19":{},"35":{},"51":{}}}],["emoji",{"_index":172,"title":{"41":{}},"description":{"41":{}}}],["enabl",{"_index":54,"title":{"12":{}},"description":{"12":{},"29":{}}}],["encod",{"_index":124,"title":{},"description":{"28":{}}}],["end",{"_index":119,"title":{},"description":{"26":{}}}],["endpoint",{"_index":140,"title":{"31":{}},"description":{"38":{},"57":{},"58":{}}}],["entri",{"_index":38,"title":{"7":{}},"description":{}}],["error",{"_index":40,"title":{"8":{}},"description":{"8":{}}}],["event",{"_index":158,"title":{},"description":{"34":{},"37":{}}}],["exist",{"_index":15,"title":{},"description":{"3":{}}}],["extern",{"_index":131,"title":{"35":{},"51":{}},"description":{"29":{},"30":{},"34":{},"35":{},"51":{}}}],["ffmpeg",{"_index":82,"title":{"20":{}},"description":{"20":{}}}],["filter",{"_index":45,"title":{},"description":{"10":{},"23":{}}}],["front",{"_index":139,"title":{"31":{}},"description":{}}],["frontend",{"_index":145,"title":{},"description":{"31":{}}}],["geo",{"_index":34,"title":{},"description":{"5":{},"6":{},"52":{}}}],["global",{"_index":196,"title":{},"description":{"59":{}}}],["handl",{"_index":133,"title":{"30":{}},"description":{}}],["hardwar",{"_index":125,"title":{"33":{}},"description":{"28":{}}}],["hide",{"_index":58,"title":{},"description":{"12":{}}}],["histor",{"_index":188,"title":{"53":{}},"description":{}}],["hit",{"_index":190,"title":{},"description":{"57":{}}}],["id",{"_index":51,"title":{},"description":{"11":{},"36":{},"54":{}}}],["ident",{"_index":70,"title":{},"description":{"16":{}}}],["identifi",{"_index":184,"title":{"47":{}},"description":{}}],["inbound",{"_index":12,"title":{"22":{}},"description":{"3":{},"22":{}}}],["includ",{"_index":98,"title":{},"description":{"23":{}}}],["inform",{"_index":189,"title":{"56":{},"59":{}},"description":{"56":{},"58":{},"59":{}}}],["insert",{"_index":144,"title":{},"description":{"31":{}}}],["integr",{"_index":109,"title":{"42":{}},"description":{"25":{},"44":{}}}],["interact",{"_index":177,"title":{},"description":{"42":{}}}],["interfac",{"_index":166,"title":{},"description":{"38":{},"56":{},"58":{}}}],["itself",{"_index":104,"title":{},"description":{"24":{}}}],["key",{"_index":20,"title":{"4":{},"13":{}},"description":{"4":{},"13":{}}}],["latenc",{"_index":110,"title":{"26":{}},"description":{"26":{}}}],["less",{"_index":118,"title":{},"description":{"26":{}}}],["level",{"_index":111,"title":{"26":{}},"description":{"26":{},"33":{}}}],["link",{"_index":134,"title":{},"description":{"30":{}}}],["list",{"_index":29,"title":{"5":{},"6":{},"52":{}},"description":{"5":{},"6":{},"10":{},"41":{},"52":{}}}],["listen",{"_index":89,"title":{},"description":{"21":{},"22":{}}}],["local",{"_index":27,"title":{},"description":{"4":{}}}],["log",{"_index":37,"title":{"7":{},"8":{}},"description":{"7":{},"8":{}}}],["logo",{"_index":73,"title":{"18":{}},"description":{"18":{}}}],["mark",{"_index":92,"title":{"23":{},"57":{}},"description":{"23":{}}}],["markdown",{"_index":65,"title":{},"description":{"14":{}}}],["memori",{"_index":154,"title":{},"description":{"33":{}}}],["messag",{"_index":43,"title":{"10":{},"11":{},"40":{},"44":{},"45":{},"47":{},"53":{},"54":{}},"description":{"10":{},"12":{},"40":{},"44":{},"45":{},"47":{},"53":{}}}],["more",{"_index":120,"title":{},"description":{"26":{}}}],["much",{"_index":113,"title":{},"description":{"26":{}}}],["name",{"_index":67,"title":{"16":{}},"description":{"16":{}}}],["network",{"_index":135,"title":{},"description":{"30":{}}}],["number",{"_index":193,"title":{},"description":{"58":{}}}],["on",{"_index":14,"title":{},"description":{"3":{}}}],["oper",{"_index":5,"title":{},"description":{"1":{}}}],["option",{"_index":33,"title":{},"description":{"5":{},"6":{},"25":{},"52":{}}}],["output",{"_index":121,"title":{"27":{}},"description":{}}],["over",{"_index":146,"title":{"32":{}},"description":{"32":{},"33":{}}}],["owncast",{"_index":23,"title":{"21":{},"24":{},"25":{}},"description":{"4":{},"9":{},"21":{},"22":{},"24":{},"25":{},"42":{},"59":{}}}],["page",{"_index":63,"title":{"14":{},"59":{}},"description":{"14":{},"31":{},"59":{}}}],["parti",{"_index":176,"title":{},"description":{"42":{},"44":{}}}],["pass",{"_index":49,"title":{},"description":{"11":{},"54":{}}}],["password",{"_index":61,"title":{},"description":{"13":{}}}],["path",{"_index":74,"title":{"20":{}},"description":{"18":{},"20":{}}}],["period",{"_index":151,"title":{},"description":{"32":{},"33":{},"57":{}}}],["ping",{"_index":191,"title":{},"description":{"57":{}}}],["place",{"_index":183,"title":{},"description":{"46":{}}}],["port",{"_index":88,"title":{"21":{},"22":{}},"description":{"21":{},"22":{}}}],["prior",{"_index":170,"title":{},"description":{"40":{}}}],["problem",{"_index":22,"title":{},"description":{"4":{}}}],["profil",{"_index":136,"title":{},"description":{"30":{}}}],["provid",{"_index":130,"title":{},"description":{"29":{},"48":{}}}],["public",{"_index":107,"title":{"25":{}},"description":{"25":{}}}],["purpos",{"_index":99,"title":{},"description":{"23":{}}}],["recent",{"_index":36,"title":{"7":{},"8":{}},"description":{"8":{}}}],["redoc-inject",{"_index":2,"title":{},"description":{"0":{}}}],["regist",{"_index":103,"title":{"39":{}},"description":{"24":{},"39":{}}}],["registr",{"_index":19,"title":{"4":{}},"description":{"4":{}}}],["rel",{"_index":75,"title":{},"description":{"18":{}}}],["relat",{"_index":165,"title":{},"description":{"38":{}}}],["request",{"_index":164,"title":{},"description":{"37":{}}}],["requir",{"_index":6,"title":{},"description":{"1":{}}}],["reset",{"_index":17,"title":{"4":{}},"description":{"4":{}}}],["return",{"_index":28,"title":{"5":{},"6":{},"7":{},"8":{},"34":{},"50":{},"52":{}},"description":{"5":{},"6":{},"7":{},"8":{},"34":{},"39":{},"50":{},"52":{}}}],["rtmp",{"_index":90,"title":{"22":{}},"description":{}}],["s3",{"_index":129,"title":{},"description":{"29":{}}}],["safe",{"_index":93,"title":{"23":{}},"description":{"23":{}}}],["save",{"_index":141,"title":{},"description":{"31":{}}}],["scope",{"_index":186,"title":{},"description":{"48":{}}}],["security-definit",{"_index":3,"title":{},"description":{"0":{}}}],["send",{"_index":178,"title":{"44":{},"45":{},"46":{},"47":{}},"description":{"44":{},"45":{},"46":{},"47":{}}}],["server",{"_index":7,"title":{"2":{},"9":{},"16":{},"17":{},"18":{},"19":{},"22":{},"24":{},"25":{},"55":{}},"description":{"7":{},"9":{},"16":{},"18":{},"19":{},"21":{},"24":{},"25":{},"26":{},"42":{},"58":{},"59":{}}}],["server'",{"_index":72,"title":{},"description":{"17":{}}}],["servic",{"_index":91,"title":{},"description":{"22":{},"44":{},"59":{}}}],["set",{"_index":60,"title":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"35":{},"43":{},"51":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"35":{},"43":{},"51":{}}}],["show",{"_index":80,"title":{},"description":{"19":{}}}],["singl",{"_index":56,"title":{"12":{},"36":{}},"description":{"12":{},"36":{},"37":{},"47":{},"48":{},"49":{}}}],["social",{"_index":132,"title":{"30":{}},"description":{"30":{}}}],["specif",{"_index":84,"title":{},"description":{"20":{},"28":{}}}],["stat",{"_index":152,"title":{"33":{}},"description":{}}],["statu",{"_index":8,"title":{"2":{},"58":{}},"description":{}}],["storag",{"_index":127,"title":{"29":{}},"description":{"29":{}}}],["stream",{"_index":13,"title":{"13":{},"15":{},"23":{},"26":{},"27":{},"43":{}},"description":{"3":{},"13":{},"15":{},"17":{},"23":{},"27":{},"43":{}}}],["string",{"_index":142,"title":{},"description":{"31":{}}}],["style",{"_index":138,"title":{"31":{}},"description":{}}],["summari",{"_index":71,"title":{"17":{}},"description":{"17":{}}}],["support",{"_index":100,"title":{"24":{}},"description":{"27":{},"28":{},"41":{}}}],["system",{"_index":86,"title":{"45":{},"47":{}},"description":{"20":{},"28":{}}}],["system/serv",{"_index":181,"title":{},"description":{"45":{},"47":{}}}],["tag",{"_index":77,"title":{"19":{}},"description":{"19":{}}}],["termin",{"_index":16,"title":{},"description":{"3":{}}}],["time",{"_index":147,"title":{"32":{}},"description":{}}],["titl",{"_index":66,"title":{"15":{},"43":{}},"description":{"15":{},"43":{}}}],["token",{"_index":168,"title":{"48":{},"49":{},"50":{}},"description":{"39":{},"48":{},"49":{},"50":{}}}],["took",{"_index":182,"title":{},"description":{"46":{}}}],["track",{"_index":148,"title":{},"description":{"32":{},"57":{}}}],["true",{"_index":101,"title":{},"description":{"24":{}}}],["ui",{"_index":160,"title":{},"description":{"35":{},"51":{}}}],["unfilt",{"_index":44,"title":{"10":{}},"description":{}}],["up",{"_index":81,"title":{},"description":{"19":{},"26":{}}}],["updat",{"_index":47,"title":{"11":{},"54":{}},"description":{"58":{}}}],["url",{"_index":108,"title":{"25":{},"35":{},"51":{}},"description":{"25":{},"35":{},"51":{}}}],["us",{"_index":21,"title":{"31":{}},"description":{"4":{},"13":{},"14":{},"23":{},"25":{},"28":{},"40":{},"53":{},"56":{},"58":{},"59":{}}}],["user",{"_index":57,"title":{"12":{},"39":{}},"description":{"12":{},"39":{},"56":{},"58":{}}}],["user'",{"_index":59,"title":{},"description":{"12":{}}}],["usernam",{"_index":69,"title":{},"description":{"16":{}}}],["util",{"_index":156,"title":{},"description":{"33":{}}}],["variant",{"_index":122,"title":{},"description":{"27":{}}}],["via",{"_index":25,"title":{},"description":{"4":{}}}],["video",{"_index":114,"title":{"28":{}},"description":{"26":{},"28":{}}}],["viewer",{"_index":117,"title":{"32":{},"57":{}},"description":{"26":{},"32":{},"57":{},"58":{}}}],["visibl",{"_index":48,"title":{"11":{},"54":{}},"description":{"11":{},"54":{}}}],["want",{"_index":52,"title":{},"description":{"11":{},"54":{}}}],["warn",{"_index":39,"title":{"8":{}},"description":{"8":{}}}],["web",{"_index":87,"title":{"21":{},"31":{}},"description":{"21":{},"31":{}}}],["webhook",{"_index":157,"title":{"34":{},"36":{},"37":{}},"description":{"34":{},"36":{},"37":{}}}],["webroot",{"_index":76,"title":{},"description":{"18":{}}}],["websocket",{"_index":171,"title":{},"description":{"40":{}}}],["well",{"_index":194,"title":{},"description":{"58":{}}}],["work",{"_index":94,"title":{"23":{}},"description":{"23":{}}}],["yellow",{"_index":195,"title":{"59":{}},"description":{"59":{}}}],["yp",{"_index":18,"title":{"4":{}},"description":{"4":{}}}]],"pipeline":[]}},"options":{"hideHostname":true,"pathInMiddlePanel":true}}; var container = document.getElementById('redoc'); Redoc.hydrate(__redoc_state, container); |