/

/Owncast APIs

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

Checked 1h ago · Updated 2w ago View markdown

Chat1

External11

Internal124

Objects109

options/chat/register
options/metrics/cmcd
options/admin/status
options/admin/disconnect
options/admin/serverconfig
options/admin/viewersOverTime
options/admin/viewers
options/admin/viewers/playback
options/admin/hardwarestats
options/admin/chat/clients
options/admin/chat/messages
options/admin/chat/messagevisibility
options/admin/chat/users/setenabled
options/admin/chat/users/disabled
options/admin/chat/users/ipbans/create
options/admin/chat/users/ipbans/remove
options/admin/chat/users/ipbans
options/admin/chat/users/setmoderator
options/admin/chat/users/moderators
options/admin/users
options/admin/users/delete
options/admin/logs
options/admin/logs/warnings
options/admin/followers
options/admin/followers/pending
options/admin/followers/blocked
options/admin/followers/directory
options/admin/followers/approve
options/admin/followers/remove
options/admin/emoji/upload
options/admin/emoji/delete
options/admin/config/adminpass
options/admin/config/streamkeys
options/admin/config/pagecontent
options/admin/config/streamtitle
postChange the server name
options/admin/config/name
postChange the server summary
options/admin/config/serversummary
postChange the offline message
options/admin/config/offlinemessage
options/admin/config/welcomemessage
options/admin/config/chat/disable
options/admin/config/chat/joinmessagesenabled
options/admin/config/chat/establishedusermode
options/admin/config/chat/forbiddenusernames
options/admin/config/chat/suggestedusernames
options/admin/config/chat/spamprotectionenabled
options/admin/config/chat/slurfilterenabled
options/admin/config/chat/requireauthentication
options/admin/config/video/codec
options/admin/config/video/streamlatencylevel
options/admin/config/video/streamoutputvariants
options/admin/config/appearance
options/admin/config/logo
options/admin/config/favicon
options/admin/config/tags
options/admin/config/ffmpegpath
options/admin/config/webserverport
options/admin/config/webserverip
options/admin/config/rtmpserverport
options/admin/config/rtmpserverbindaddress
options/admin/config/sockethostoverride
options/admin/config/videoservingendpoint
options/admin/config/nsfw
options/admin/config/autoplay
options/admin/config/directoryenabled
options/admin/config/socialhandles
options/admin/config/s3
options/admin/config/serverurl
options/admin/config/externalactions
options/admin/config/customstyles
options/admin/config/customjavascript
options/admin/config/hideviewercount
options/admin/config/disablesearchindexing
options/admin/config/federation/enable
options/admin/config/federation/private
options/admin/config/federation/showengagement
options/admin/config/federation/enablequotes
options/admin/config/federation/hidefollowers
options/admin/config/federation/username
options/admin/config/federation/livemessage
options/admin/config/federation/blockdomains
options/admin/federation/servers
options/admin/federation/servers/{id}
options/admin/config/notifications/discord
options/admin/config/notifications/browser
options/admin/webhooks
options/admin/webhooks/delete
options/admin/webhooks/create
options/admin/accesstokens
options/admin/accesstokens/delete
options/admin/accesstokens/create
options/admin/update/options
options/admin/update/start
options/admin/update/forcequit
options/admin/yp/reset
options/admin/metrics/video
options/admin/federation/send
options/admin/federation/actions
options/integrations/chat/system
options/integrations/chat/system/client/{clientId}
options/integrations/chat/user
options/integrations/chat/send
options/integrations/chat/action
options/integrations/chat/messagevisibility
options/integrations/streamtitle
options/integrations/chat
options/integrations/clients

Objects

Internal

Admin

Change the server summary

post/admin/config/serversummary

Request body

Response

Server summary has been changed

messagestring

successboolean