From e38aa5935b142c25dc1d6d3de9717489d75f3e15 Mon Sep 17 00:00:00 2001 From: Owncast Date: Thu, 22 Jul 2021 00:20:22 +0000 Subject: [PATCH] Commit updated API documentation --- doc/api/index.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/index.html b/doc/api/index.html index 26b58a3da..1b9707734 100644 --- a/doc/api/index.html +++ b/doc/api/index.html @@ -453,7 +453,7 @@ data-styled.g140[id="sc-amkrK"]{content:"icZuVc,"}/*!sc*/ -
logo
Documentation Powered by ReDoc
logo
Documentation Powered by ReDoc
Authorizations:
AdminBasicAuth

Responses

Response samples

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

Reset your YP registration key.

Used when there is a problem with your registration to the Owncast Directory via the YP APIs. This will reset your local registration key.

Authorizations:
AdminBasicAuth

Responses

Response samples

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

Return a list of currently connected clients

Return a list of currently connected clients with optional geo details.

+

Response samples

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

Return a list of currently connected clients

Return a list of currently connected clients with optional geo details.

Authorizations:
AdminBasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return a list of currently connected clients

Return a list of currently connected clients with optional geo details.

Authorizations:
AdminBasicAuth

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
}

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"
}