/
OW
owncast
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Chat
1
External
11
Internal
122
get
/status
Get the status of the server
get
/emoji
Get list of custom emojis supported in the chat
get
/chat
Gets a list of chat messages
post
/chat/register
Resolves a gate session or registers an anonymous chat user
post
/chat/messagevisibility
Update chat message visibility
post
/chat/users/setenabled
Enable/disable a user
get
/config
Get the web config
get
/yp
Get the YP protocol data
get
/socialplatforms
Get all social platforms
get
/video/variants
Get a list of video variants available
get
/ping
Tell the backend you're an active viewer
post
/remotefollow
Request remote follow
get
/followers
Gets the list of followers
get
/metrics/cmcd
CMCD collector accepting a report as a query parameter
post
/metrics/cmcd
CMCD collector accepting event and response mode playback reports
post
/metrics/playback
Save video playback metrics for future video health recording
post
/notifications/register
Register for notifications
get
/admin/status
Get current inboard broadcaster
post
/admin/disconnect
Disconnect inbound stream
get
/admin/serverconfig
Get the current server config
get
/admin/viewersOverTime
Get viewer count over time
get
/admin/viewers
Get active viewers
get
/admin/viewers/playback
Get the playback clients of active viewers with their current playback health
get
/admin/hardwarestats
Get the current hardware stats
get
/admin/chat/clients
Get a detailed list of currently connected chat clients
get
/admin/chat/messages
Get all chat messages for the admin, unfiltered
post
/admin/chat/messagevisibility
Update visibility of chat messages
post
/admin/chat/users/setenabled
Enable or disable a user
get
/admin/chat/users/disabled
Get a list of disabled users
post
/admin/chat/users/ipbans/create
Ban an IP address
post
/admin/chat/users/ipbans/remove
Remove an IP ban
get
/admin/chat/users/ipbans
Get all banned IP addresses
post
/admin/chat/users/setmoderator
Set moderator status for a user
get
/admin/chat/users/moderators
Get a list of moderator users
get
/admin/users
Get a paginated list of all users
post
/admin/users/delete
Permanently delete a user and all of their data
get
/admin/logs
Get all logs
get
/admin/logs/warnings
Get warning/error logs
get
/admin/followers
Get followers
get
/admin/followers/pending
Get a list of pending follow requests
get
/admin/followers/blocked
Get a list of rejected or blocked follows
get
/admin/followers/directory
Get directories that are featuring/listing this server
post
/admin/followers/approve
Set the following state of a follower or follow request
post
/admin/followers/remove
Remove a follower without blocking them (they may follow again)
post
/admin/emoji/upload
Upload custom emoji
post
/admin/emoji/delete
Delete custom emoji
post
/admin/config/adminpass
Change the current admin password
post
/admin/config/streamkeys
Set an array of valid stream keys
post
/admin/config/pagecontent
Change the extra page content in memory
post
/admin/config/streamtitle
Change the stream title
post
/admin/config/welcomemessage
Change the welcome message
post
/admin/config/chat/disable
Disable chat
post
/admin/config/chat/joinmessagesenabled
Enable chat for user join messages
post
/admin/config/chat/establishedusermode
Enable/disable chat established user mode
post
/admin/config/chat/forbiddenusernames
Set chat usernames that are not allowed
post
/admin/config/chat/suggestedusernames
Set the suggested chat usernames that will be assigned automatically
post
/admin/config/chat/spamprotectionenabled
Set spam protection enabled
post
/admin/config/chat/slurfilterenabled
Set slur filter enabled
post
/admin/config/chat/requireauthentication
Set require authentication for chat
post
/admin/config/video/codec
Set video codec
post
/admin/config/video/streamlatencylevel
Set the number of video segments and duration per segment in a playlist
post
/admin/config/video/streamoutputvariants
Set an array of video output configurations
post
/admin/config/appearance
Set style/color/css values
post
/admin/config/logo
Update logo
post
/admin/config/favicon
Upload custom favicon
delete
/admin/config/favicon
Reset favicon to default
post
/admin/config/tags
Update server tags
post
/admin/config/ffmpegpath
Update FFMPEG path
post
/admin/config/webserverport
Update server port
post
/admin/config/webserverip
Update server IP address
post
/admin/config/rtmpserverport
Update RTMP post
post
/admin/config/rtmpserverbindaddress
Update RTMP server bind address
post
/admin/config/sockethostoverride
Update websocket host override
post
/admin/config/videoservingendpoint
Update custom video serving endpoint
post
/admin/config/nsfw
Update NSFW marking
post
/admin/config/autoplay
Update autoplay behavior
post
/admin/config/directoryenabled
Update directory enabled
post
/admin/config/socialhandles
Update social handles
post
/admin/config/s3
Update S3 configuration
post
/admin/config/serverurl
Update server url
post
/admin/config/externalactions
Update external action links
post
/admin/config/customstyles
Update custom styles
post
/admin/config/customjavascript
Update custom JavaScript
post
/admin/config/hideviewercount
Update hide viewer count
post
/admin/config/disablesearchindexing
Update search indexing
post
/admin/config/federation/enable
Enable/disable federation features
post
/admin/config/federation/private
Set if federation activities are private
post
/admin/config/federation/showengagement
Set if fediverse engagement appears in chat
post
/admin/config/federation/enablequotes
Set if posts from this server can be quoted
post
/admin/config/federation/hidefollowers
Set if the public followers tab is hidden on the web UI
post
/admin/config/federation/username
Set local federated username
post
/admin/config/federation/livemessage
Set federated go live message
post
/admin/config/federation/blockdomains
Set Federation blocked domains
get
/federation/servers
Get list of federated servers
get
/admin/federation/servers
Get all federated servers (admin), including pending requests
post
/admin/federation/servers
Add a federated server to follow
delete
/admin/federation/servers/{id}
Remove a federated server
put
/admin/federation/servers/{id}/reorder
Move a federated server up or down in the priority order
get
/admin/federation/feature-requests
Get pending requests from other servers to feature this server's stream
post
/admin/config/notifications/discord
Configure Discord notifications
post
/admin/config/notifications/browser
Configure Browser notifications
get
/admin/webhooks
Get all the webhooks
post
/admin/webhooks/delete
Delete a single webhook
post
/admin/webhooks/create
Create a single webhook
get
/admin/accesstokens
Get all access tokens
post
/admin/accesstokens/delete
Delete a single external API user
post
/admin/accesstokens/create
Create a single access token
post
/admin/yp/reset
Reset YP configuration
get
/admin/metrics/video
Get video playback metrics
get
/admin/prometheus
Endpoint to interface with Prometheus
put
/admin/prometheus
Endpoint to interface with Prometheus
post
/admin/prometheus
Endpoint to interface with Prometheus
delete
/admin/prometheus
Endpoint to interface with Prometheus
options
/admin/prometheus
Endpoint to interface with Prometheus
post
/admin/federation/send
Send a public message to the Fediverse from the server's user
get
/admin/federation/actions
Get a paginated list of federated activities
post
/auth/indieauth
Begins auth flow
get
/auth/indieauth/callback
Handle the redirect from an IndieAuth server to continue the auth flow
get
/auth/provider/indieauth
Handles the IndieAuth auth endpoint
post
/auth/provider/indieauth
Handles IndieAuth from form submission
post
/auth/fediverse
Register a Fediverse OTP request
post
/auth/fediverse/verify
Verify Fediverse OTP code
Objects
107
Internal
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Set if fediverse engagement appears in chat
post
/admin/config/federation/showengagement
Jul 2, 2024
618b7ae59cc5
Revision changes
info
endpoint added
Sep 23, 2021
02fef72d775b
Revision changes
breaking
api path removed without deprecation