/
OW
owncast
/
Owncast APIs
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 2w ago
latest
OpenAPI 3.1.0
MIT
raw.githubusercontent.com
2026-08-09
245
75
165.4 KB
dc1c42f7f8f6
Chat
1
get
Get a user's details
External
11
post
Send a system message to the chat
post
Send a system message to a single client
post
Send a user message to chat
post
Send a message to chat as a specific 3rd party bot/integration based on its access token
post
Send a user action to chat
post
Hide chat message
get
Get the server's status
post
Stream title
get
Get chat history
get
Connected clients
get
Get a user's details
Internal
124
get
Get the status of the server
get
Get list of custom emojis supported in the chat
get
Gets a list of chat messages
post
Registers an anonymous chat user
post
Update chat message visibility
post
Enable/disable a user
get
Get the web config
get
Get the YP protocol data
get
Get all social platforms
get
Get a list of video variants available
get
Tell the backend you're an active viewer
post
Request remote follow
get
Gets the list of followers
get
CMCD collector accepting a report as a query parameter
post
CMCD collector accepting event and response mode playback reports
post
Save video playback metrics for future video health recording
post
Register for notifications
get
Get current inboard broadcaster
get
Disconnect inbound stream
get
Get the current server config
get
Get viewer count over time
get
Get active viewers
get
Get the playback clients of active viewers with their current playback health
get
Get the current hardware stats
get
Get a detailed list of currently connected chat clients
get
Get all chat messages for the admin, unfiltered
post
Update visibility of chat messages
post
Enable or disable a user
get
Get a list of disabled users
post
Ban an IP address
post
Remove an IP ban
get
Get all banned IP addresses
post
Set moderator status for a user
get
Get a list of moderator users
get
Get a paginated list of all users
post
Permanently delete a user and all of their data
get
Get all logs
get
Get warning/error logs
get
Get followers
get
Get a list of pending follow requests
get
Get a list of rejected or blocked follows
get
Get directories that are featuring/listing this server
post
Set the following state of a follower or follow request
post
Remove a follower without blocking them (they may follow again)
post
Upload custom emoji
post
Delete custom emoji
post
Change the current admin password
post
Set an array of valid stream keys
post
Change the extra page content in memory
post
Change the stream title
post
Change the welcome message
post
Disable chat
post
Enable chat for user join messages
post
Enable/disable chat established user mode
post
Set chat usernames that are not allowed
post
Set the suggested chat usernames that will be assigned automatically
post
Set spam protection enabled
post
Set slur filter enabled
post
Set require authentication for chat
post
Set video codec
post
Set the number of video segments and duration per segment in a playlist
post
Set an array of video output configurations
post
Set style/color/css values
post
Update logo
post
Upload custom favicon
delete
Reset favicon to default
post
Update server tags
post
Update FFMPEG path
post
Update server port
post
Update server IP address
post
Update RTMP post
post
Update RTMP server bind address
post
Update websocket host override
post
Update custom video serving endpoint
post
Update NSFW marking
post
Update autoplay behavior
post
Update directory enabled
post
Update social handles
post
Update S3 configuration
post
Update server url
post
Update external action links
post
Update custom styles
post
Update custom JavaScript
post
Update hide viewer count
post
Update search indexing
post
Enable/disable federation features
post
Set if federation activities are private
post
Set if fediverse engagement appears in chat
post
Set if posts from this server can be quoted
post
Set if the public followers tab is hidden on the web UI
post
Set local federated username
post
Set federated go live message
post
Set Federation blocked domains
get
Get list of federated servers
get
Get all federated servers (admin), including pending requests
post
Add a federated server to follow
delete
Remove a federated server
get
Get pending requests from other servers to feature this server's stream
post
Configure Discord notifications
post
Configure Browser notifications
get
Get all the webhooks
post
Delete a single webhook
post
Create a single webhook
get
Get all access tokens
post
Delete a single external API user
post
Create a single access token
get
Return the auto-update features that are supported for this instance
get
Begin the auto-update
get
Force quit the server and restart it
get
Reset YP configuration
get
Get video playback metrics
get
Endpoint to interface with Prometheus
put
Endpoint to interface with Prometheus
post
Endpoint to interface with Prometheus
delete
Endpoint to interface with Prometheus
options
Endpoint to interface with Prometheus
post
Send a public message to the Fediverse from the server's user
get
Get a paginated list of federated activities
post
Begins auth flow
get
Handle the redirect from an IndieAuth server to continue the auth flow
get
Handles the IndieAuth auth endpoint
post
Handles IndieAuth from form submission
post
Register a Fediverse OTP request
post
Verify Fediverse OTP code
Objects
109
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
post
Change the server name
options
/admin/config/name
post
Change the server summary
options
/admin/config/serversummary
post
Change 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
Internal
Get the status of the server
get
/status
Response
Successful response
Status
required
Response for status
serverTime
string
lastConnectTime
string
nullable
lastDisconnectTime
string
nullable
versionNumber
string
viewerCount
integer
online
boolean
streamTitle
string