/
OW
owncast
/
Owncast APIs
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v52
latest
OpenAPI 3.1.0
MIT
raw.githubusercontent.com
2026-08-02
245
74
165.3 KB
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
All 245 operations
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
options
/chat/register
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
options
/metrics/cmcd
post
Save video playback metrics for future video health recording
post
Register for notifications
get
Get current inboard broadcaster
options
/admin/status
get
Disconnect inbound stream
options
/admin/disconnect
get
Get the current server config
options
/admin/serverconfig
get
Get viewer count over time
options
/admin/viewersOverTime
get
Get active viewers
options
/admin/viewers
get
Get the playback clients of active viewers with their current playback health
options
/admin/viewers/playback
get
Get the current hardware stats
options
/admin/hardwarestats
get
Get a detailed list of currently connected chat clients
options
/admin/chat/clients
get
Get all chat messages for the admin, unfiltered
options
/admin/chat/messages
post
Update visibility of chat messages
options
/admin/chat/messagevisibility
post
Enable or disable a user
options
/admin/chat/users/setenabled
get
Get a list of disabled users
options
/admin/chat/users/disabled
post
Ban an IP address
options
/admin/chat/users/ipbans/create
post
Remove an IP ban
options
/admin/chat/users/ipbans/remove
get
Get all banned IP addresses
options
/admin/chat/users/ipbans
post
Set moderator status for a user
options
/admin/chat/users/setmoderator
get
Get a list of moderator users
options
/admin/chat/users/moderators
get
Get a paginated list of all users
options
/admin/users
post
Permanently delete a user and all of their data
options
/admin/users/delete
get
Get all logs
options
/admin/logs
get
Get warning/error logs
options
/admin/logs/warnings
get
Get followers
options
/admin/followers
get
Get a list of pending follow requests
options
/admin/followers/pending
get
Get a list of rejected or blocked follows
options
/admin/followers/blocked
get
Get directories that are featuring/listing this server
options
/admin/followers/directory
post
Set the following state of a follower or follow request
options
/admin/followers/approve
post
Remove a follower without blocking them (they may follow again)
options
/admin/followers/remove
post
Upload custom emoji
options
/admin/emoji/upload
post
Delete custom emoji
options
/admin/emoji/delete
post
Change the current admin password
options
/admin/config/adminpass
post
Set an array of valid stream keys
options
/admin/config/streamkeys
post
Change the extra page content in memory
options
/admin/config/pagecontent
post
Change the stream title
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
post
Change the welcome message
options
/admin/config/welcomemessage
post
Disable chat
options
/admin/config/chat/disable
post
Enable chat for user join messages
options
/admin/config/chat/joinmessagesenabled
post
Enable/disable chat established user mode
options
/admin/config/chat/establishedusermode
post
Set chat usernames that are not allowed
options
/admin/config/chat/forbiddenusernames
post
Set the suggested chat usernames that will be assigned automatically
options
/admin/config/chat/suggestedusernames
post
Set spam protection enabled
options
/admin/config/chat/spamprotectionenabled
post
Set slur filter enabled
options
/admin/config/chat/slurfilterenabled
post
Set require authentication for chat
options
/admin/config/chat/requireauthentication
post
Set video codec
options
/admin/config/video/codec
post
Set the number of video segments and duration per segment in a playlist
options
/admin/config/video/streamlatencylevel
post
Set an array of video output configurations
options
/admin/config/video/streamoutputvariants
post
Set style/color/css values
options
/admin/config/appearance
post
Update logo
options
/admin/config/logo
post
Upload custom favicon
delete
Reset favicon to default
options
/admin/config/favicon
post
Update server tags
options
/admin/config/tags
post
Update FFMPEG path
options
/admin/config/ffmpegpath
post
Update server port
options
/admin/config/webserverport
post
Update server IP address
options
/admin/config/webserverip
post
Update RTMP post
options
/admin/config/rtmpserverport
post
Update RTMP server bind address
options
/admin/config/rtmpserverbindaddress
post
Update websocket host override
options
/admin/config/sockethostoverride
post
Update custom video serving endpoint
options
/admin/config/videoservingendpoint
post
Update NSFW marking
options
/admin/config/nsfw
post
Update autoplay behavior
options
/admin/config/autoplay
post
Update directory enabled
options
/admin/config/directoryenabled
post
Update social handles
options
/admin/config/socialhandles
post
Update S3 configuration
options
/admin/config/s3
post
Update server url
options
/admin/config/serverurl
post
Update external action links
options
/admin/config/externalactions
post
Update custom styles
options
/admin/config/customstyles
post
Update custom JavaScript
options
/admin/config/customjavascript
post
Update hide viewer count
options
/admin/config/hideviewercount
post
Update search indexing
options
/admin/config/disablesearchindexing
post
Enable/disable federation features
options
/admin/config/federation/enable
post
Set if federation activities are private
options
/admin/config/federation/private
post
Set if fediverse engagement appears in chat
options
/admin/config/federation/showengagement
post
Set if posts from this server can be quoted
options
/admin/config/federation/enablequotes
post
Set if the public followers tab is hidden on the web UI
options
/admin/config/federation/hidefollowers
post
Set local federated username
options
/admin/config/federation/username
post
Set federated go live message
options
/admin/config/federation/livemessage
post
Set Federation blocked domains
options
/admin/config/federation/blockdomains
get
Get list of federated servers
get
Get all federated servers (admin), including pending requests
post
Add a federated server to follow
options
/admin/federation/servers
delete
Remove a federated server
options
/admin/federation/servers/{id}
get
Get pending requests from other servers to feature this server's stream
post
Configure Discord notifications
options
/admin/config/notifications/discord
post
Configure Browser notifications
options
/admin/config/notifications/browser
get
Get all the webhooks
options
/admin/webhooks
post
Delete a single webhook
options
/admin/webhooks/delete
post
Create a single webhook
options
/admin/webhooks/create
get
Get all access tokens
options
/admin/accesstokens
post
Delete a single external API user
options
/admin/accesstokens/delete
post
Create a single access token
options
/admin/accesstokens/create
get
Return the auto-update features that are supported for this instance
options
/admin/update/options
get
Begin the auto-update
options
/admin/update/start
get
Force quit the server and restart it
options
/admin/update/forcequit
get
Reset YP configuration
options
/admin/yp/reset
get
Get video playback metrics
options
/admin/metrics/video
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
options
/admin/federation/send
get
Get a paginated list of federated activities
options
/admin/federation/actions
post
Send a system message to the chat
options
/integrations/chat/system
post
Send a system message to a single client
options
/integrations/chat/system/client/{clientId}
post
Send a user message to chat
options
/integrations/chat/user
post
Send a message to chat as a specific 3rd party bot/integration based on its access token
options
/integrations/chat/send
post
Send a user action to chat
options
/integrations/chat/action
post
Hide chat message
options
/integrations/chat/messagevisibility
get
Get the server's status
post
Stream title
options
/integrations/streamtitle
get
Get chat history
options
/integrations/chat
get
Connected clients
options
/integrations/clients
get
Get a user's details
get
Get a user's details
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