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:
Responses
Response samples
- 200
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:
Responses
Response samples
- 200
Content type
application/json
[- {
- "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",
- "geo": {
- "countryCode": "US",
- "regionName": "California",
- "timeZone": "America/Los_Angeles"
}, - "user": {
- "id": "yklw5Imng",
- "displayName": "awesome-pizza",
- "displayColor": 42,
- "createdAt": "2021-07-08T20:21:25.303402404-07:00",
- "previousNames": "awesome-pizza,coolPerson23"
}
}
]Return a list of currently connected clients
Return a list of currently connected clients with optional geo details.
Authorizations:
Responses
Responses
Response samples
- 200
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
- 200
Content type
application/json
{- "name": "string",
- "description": "string",
- "logo": "string",
- "nsfw": true,
- "tags": [
- "string"
], - "online": true,
- "viewerCount": 0,
- "overallMaxViewerCount": 0,
- "sessionMaxViewerCount": 0,
- "lastConnectTime": "2019-08-24T14:15:22Z"
}