From 2a3d0aa65fabf8ec0ce86d854cf6e7b79f61855b Mon Sep 17 00:00:00 2001 From: Owncast Date: Mon, 25 Mar 2024 16:05:51 +0000 Subject: [PATCH] Commit updated API documentation --- docs/api/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/index.html b/docs/api/index.html index 3d9ac4567..a4919f3bc 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2442,7 +2442,7 @@ data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/

Responses

Response samples

Content type
application/json
{
  • "lastConnectTime": "2020-10-03T21:36:22-05:00",
  • "lastDisconnectTime": null,
  • "online": true,
  • "overallMaxViewerCount": 420,
  • "sessionMaxViewerCount": 12,
  • "viewerCount": 7
}

Custom Javascript to execute.

Returns custom Javascript that was set in the Owncast admin to be run in the Owncast frontend.

Responses

Response samples

Content type
application/javascript
console.log("Hello World");

Yellow Pages Information

Information to be used in the Yellow Pages service, a global directory of Owncast servers.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "logo": "string",
  • "nsfw": true,
  • "tags": [
    ],
  • "online": true,
  • "viewerCount": 0,
  • "overallMaxViewerCount": 0,
  • "sessionMaxViewerCount": 0,
  • "lastConnectTime": "2019-08-24T14:15:22Z"
}

Get the public followers of this instance

Responses

Response samples

Content type
application/json
[]

Return the information needed to redirect a user to a fediverse server to perform a remote follow action.

Request Body schema: application/json
account
string

The fediverse username@server.tld account that wants to perform the remote follow action.

+

Response samples

Content type
application/json
[]

Return the information needed to redirect a user to a fediverse server to perform a remote follow action.

Request Body schema: application/json
account
string

The fediverse username@server.tld account that wants to perform the remote follow action.

Responses

Request samples

Content type
application/json
{
  • "account": "johnsmith@fediverse.biz"
}

Response samples