From e49b7bf805bd2326e3fc4cc6bdae4e3c42cf7de0 Mon Sep 17 00:00:00 2001 From: Owncast Date: Tue, 31 Oct 2023 18:55:40 +0000 Subject: [PATCH] Commit updated API documentation --- docs/api/index.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/index.html b/docs/api/index.html index b3d25007d..81b4e7bed 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -2088,6 +2088,8 @@ data-styled.g59[id="sc-laZMeE"]{content:"jWaWWE,"}/*!sc*/ data-styled.g60[id="sc-iNiQyp"]{content:"jrLlAa,"}/*!sc*/ .cThoNa{color:#666;}/*!sc*/ data-styled.g61[id="sc-jffHpj"]{content:"cThoNa,"}/*!sc*/ +.bArHDh{color:#666;word-break:break-word;}/*!sc*/ +data-styled.g62[id="sc-eJocfa"]{content:"bArHDh,"}/*!sc*/ .dLCGMn{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/ data-styled.g63[id="sc-oeezt"]{content:"dLCGMn,"}/*!sc*/ .hIkHYw{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/ @@ -2284,10 +2286,8 @@ data-styled.g138[id="sc-iIgjPs"]{content:"jIUTls,"}/*!sc*/ enabled
boolean

Set the enabled state of this user.

Responses

Request samples

Content type
application/json
{
  • "userId": "yklw5Imng",
  • "enabled": true
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the admin password.

Authorizations:
AdminBasicAuth
Request Body schema: application/json
string or integer or object or boolean

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the stream keys.

Authorizations:
AdminBasicAuth
Request Body schema: application/json
Array
id
string

The key used for authing a stream.

-
comment
string

The user-facing description or explanation of this single key

-

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the custom page content.

Set the custom page content using markdown.

+

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the stream keys.

Authorizations:
AdminBasicAuth
Request Body schema: application/json
Array of objects (StreamKeyArray)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the custom page content.

Set the custom page content using markdown.

Authorizations:
AdminBasicAuth
Request Body schema: application/json
string or integer or object or boolean

Responses

Request samples

Content type
application/json
{
  • "value": "# Welcome to my cool server!<br><br>I _hope_ you enjoy it."
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "message": "context specific success message"
}

Set the stream title.

Set the title of the currently streaming content.

Authorizations:
AdminBasicAuth
Request Body schema: application/json
string or integer or object or boolean

Responses

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