diff --git a/doc/api/index.html b/doc/api/index.html
index 079c3f171..81e04780e 100644
--- a/doc/api/index.html
+++ b/doc/api/index.html
@@ -15,7 +15,7 @@
- Owncast (0.0.3) Download OpenAPI specification:Download
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 master branch.
-
AdminBasicAuthThe username for admin basic auth is admin
and the password is the stream key.
-
Security Scheme Type HTTP HTTP Authorization Scheme basic
Admin operations requiring authentication.
-
Server status and broadcaster Responses 200 Server status and broadcaster details
- Response samples Content type application/json
Copy
Expand all Collapse all { "broadcaster" :
{ "remoteAddr" : "172.217.164.110" ,
"time" : "2020-10-06T23:20:44.588649-07:00" ,
} , "online" : true ,
"viewerCount" : 3 ,
"overallPeakViewerCount" : 4 ,
"sessionPeakViewerCount" : 4 ,
"versionNumber" : "0.0.3" ,
"disableUpgradeChecks" : false
}
Disconnect Broadcaster post /api/admin/disconnect Disconnect the active inbound stream, if one exists, and terminate the broadcast.
-
Responses 200 Operation Success/Failure Response
- Response samples Content type application/json
Example Operation succeeded.
Operation failed.
Copy
Expand all Collapse all Return a list of currently connected clients Return a list of currently connected clients with optional geo details.
-
Responses 200 Successful response of an array of clients
- Response samples Content type application/json
Copy
Expand all Collapse all [ { "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" ,
"username" : "coolperson42" ,
"clientID" : "2ba20dd34f911c198df3218ddc64c740" ,
} ]
Return recent log entries Responses 200 Response of server log entries
- Response samples Content type application/json
Copy
Expand all Collapse all [ { "message" : "RTMP server is listening for incoming stream on port: 1935" ,
"level" : "info" ,
"time" : "2020-10-29T18:35:35.011823-07:00"
} ]
Return recent warning and error logs. get /api/admin/logs/warnings Return recent warning and error logs.
-
Responses 200 Response of server log entries
- Response samples Content type application/json
Copy
Expand all Collapse all [ { "message" : "RTMP server is listening for incoming stream on port: 1935" ,
"level" : "info" ,
"time" : "2020-10-29T18:35:35.011823-07:00"
} ]
Update Stream Key. Pre-release, do not use. Change the stream key in memory, but not in the config file. This will require all broadcasters to be reconfigured to connect again.
-
Request Body schema: application/json
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Copy
Expand all Collapse all { "success" : true ,
"message" : "changed"
}
Server Configuration get /api/admin/serverconfig Get the current configuration of the Owncast server.
-
Response samples Content type application/json
Copy
Expand all Collapse all { "instanceDetails" :
{ "name" : "string" ,
"title" : "string" ,
"summary" : "string" ,
"logo" : "string" ,
"extraPageContent" : "<p>This page is <strong>super</strong> cool!" ,
"version" : "Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"
} , "ffmpegPath" : "string" ,
"webServerPort" : 0 ,
"yp" :
{ "enabled" : false ,
"instanceUrl" : "string"
} }
Viewers Over Time get /api/admin/viewersOverTime
/api/admin/viewersOverTime
Get the tracked viewer count over the collected period.
-
Response samples Content type application/json
Copy
Expand all Collapse all Hardware Stats get /api/admin/hardwarestats Get the CPU, Memory and Disk utilization levels over the collected period.
-
Response samples Content type application/json
Copy
Expand all Collapse all Endpoints related to the chat interface.
-
Historical Chat Messages Used to get all chat messages prior to connecting to the websocket.
-
Response samples Content type application/json
Copy
Expand all Collapse all Get Custom Emoji Get a list of custom emoji that are supported in chat.
-
Response samples Content type application/json
Copy
Expand all Collapse all Information The client configuration. Information useful for the user interface.
-
Response samples Content type application/json
Copy
Expand all Collapse all { "name" : "string" ,
"title" : "string" ,
"summary" : "string" ,
"logo" : "string" ,
"extraPageContent" : "<p>This page is <strong>super</strong> cool!" ,
"version" : "Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"
}
Current Status 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.
-
Response samples Content type application/json
Copy
Expand all Collapse all { "lastConnectTime" : "2020-10-03T21:36:22-05:00" ,
"lastDisconnectTime" : null ,
"online" : true ,
"overallMaxViewerCount" : 420 ,
"sessionMaxViewerCount" : 12 ,
"viewerCount" : 7
}
Yellow Pages Information Information to be used in the Yellow Pages service, a global directory of Owncast servers.
-
Response samples Content type application/json
Copy
Expand all Collapse all { "name" : "string" ,
"description" : "string" ,
"logo" : "string" ,
"nsfw" : true ,
"online" : true ,
"viewerCount" : 0 ,
"overallMaxViewerCount" : 0 ,
"sessionMaxViewerCount" : 0 ,
"lastConnectTime" : "2019-08-24T14:15:22Z"
}
Update Stream Key. Pre-release, do not use. Change the stream key in memory, but not in the config file. This will require all broadcasters to be reconfigured to connect again.
-
Request Body schema: application/json
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Copy
Expand all Collapse all { "success" : true ,
"message" : "changed"
}
+ " fill="currentColor">
Owncast (0.0.4-development) Download OpenAPI specification:Download
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 master branch.
+
AdminBasicAuthThe username for admin basic auth is admin
and the password is the stream key.
+
Security Scheme Type HTTP HTTP Authorization Scheme basic
Admin operations requiring authentication.
+
Server status and broadcaster Responses 200 Server status and broadcaster details
+ Response samples Content type application/json
Copy
Expand all Collapse all { "broadcaster" :
{ "remoteAddr" : "172.217.164.110" ,
"time" : "2020-10-06T23:20:44.588649-07:00" ,
} , "online" : true ,
"viewerCount" : 3 ,
"overallPeakViewerCount" : 4 ,
"sessionPeakViewerCount" : 4 ,
"versionNumber" : "0.0.3" ,
"disableUpgradeChecks" : false
}
Disconnect Broadcaster post /api/admin/disconnect Disconnect the active inbound stream, if one exists, and terminate the broadcast.
+
Responses 200 Operation Success/Failure Response
+ Response samples Content type application/json
Example Operation succeeded.
Operation failed.
Copy
Expand all Collapse all Return a list of currently connected clients Return a list of currently connected clients with optional geo details.
+
Responses 200 Successful response of an array of clients
+ Response samples Content type application/json
Copy
Expand all Collapse all [ { "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" ,
"username" : "coolperson42" ,
"clientID" : "2ba20dd34f911c198df3218ddc64c740" ,
} ]
Return recent log entries Responses 200 Response of server log entries
+ Response samples Content type application/json
Copy
Expand all Collapse all [ { "message" : "RTMP server is listening for incoming stream on port: 1935" ,
"level" : "info" ,
"time" : "2020-10-29T18:35:35.011823-07:00"
} ]
Return recent warning and error logs. get /api/admin/logs/warnings Return recent warning and error logs.
+
Responses 200 Response of server log entries
+ Response samples Content type application/json
Copy
Expand all Collapse all [ { "message" : "RTMP server is listening for incoming stream on port: 1935" ,
"level" : "info" ,
"time" : "2020-10-29T18:35:35.011823-07:00"
} ]
Update Stream Key. Pre-release, do not use. Change the stream key in memory, but not in the config file. This will require all broadcasters to be reconfigured to connect again.
+
Request Body schema: application/json
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Copy
Expand all Collapse all { "success" : true ,
"message" : "changed"
}
Server Configuration get /api/admin/serverconfig Get the current configuration of the Owncast server.
+
Response samples Content type application/json
Copy
Expand all Collapse all { "instanceDetails" :
{ "name" : "string" ,
"title" : "string" ,
"summary" : "string" ,
"logo" : "string" ,
"extraPageContent" : "<p>This page is <strong>super</strong> cool!" ,
"version" : "Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"
} , "ffmpegPath" : "string" ,
"webServerPort" : 0 ,
"yp" :
{ "enabled" : false ,
"instanceUrl" : "string"
} }
Viewers Over Time get /api/admin/viewersOverTime
/api/admin/viewersOverTime
Get the tracked viewer count over the collected period.
+
Response samples Content type application/json
Copy
Expand all Collapse all Hardware Stats get /api/admin/hardwarestats Get the CPU, Memory and Disk utilization levels over the collected period.
+
Response samples Content type application/json
Copy
Expand all Collapse all Endpoints related to the chat interface.
+
Historical Chat Messages Used to get all chat messages prior to connecting to the websocket.
+
Response samples Content type application/json
Copy
Expand all Collapse all Get Custom Emoji Get a list of custom emoji that are supported in chat.
+
Response samples Content type application/json
Copy
Expand all Collapse all Information The client configuration. Information useful for the user interface.
+
Response samples Content type application/json
Copy
Expand all Collapse all { "name" : "string" ,
"title" : "string" ,
"summary" : "string" ,
"logo" : "string" ,
"extraPageContent" : "<p>This page is <strong>super</strong> cool!" ,
"version" : "Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"
}
Current Status 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.
+
Response samples Content type application/json
Copy
Expand all Collapse all { "lastConnectTime" : "2020-10-03T21:36:22-05:00" ,
"lastDisconnectTime" : null ,
"online" : true ,
"overallMaxViewerCount" : 420 ,
"sessionMaxViewerCount" : 12 ,
"viewerCount" : 7
}
Yellow Pages Information Information to be used in the Yellow Pages service, a global directory of Owncast servers.
+
Response samples Content type application/json
Copy
Expand all Collapse all { "name" : "string" ,
"description" : "string" ,
"logo" : "string" ,
"nsfw" : true ,
"online" : true ,
"viewerCount" : 0 ,
"overallMaxViewerCount" : 0 ,
"sessionMaxViewerCount" : 0 ,
"lastConnectTime" : "2019-08-24T14:15:22Z"
}
Update Stream Key. Pre-release, do not use. Change the stream key in memory, but not in the config file. This will require all broadcasters to be reconfigured to connect again.
+
Request Body schema: application/json
Request samples Content type application/json
Copy
Expand all Collapse all Response samples Content type application/json
Copy
Expand all Collapse all { "success" : true ,
"message" : "changed"
}