mirror of
https://git.waldn.net/git/knotteye/satyr.git
synced 2025-09-09 07:16:44 +00:00
Implement an API call for getting the current stream key.
This commit is contained in:
18
docs/REST.md
18
docs/REST.md
@ -188,7 +188,9 @@ Notes: VODs are always available at http://domain.com/publicEndpoint/username/fi
|
||||
|
||||
|
||||
|
||||
## /api/:user/config
|
||||
### /api/:user/config
|
||||
|
||||
Get information about the specified user.
|
||||
|
||||
Method: GET
|
||||
|
||||
@ -202,8 +204,16 @@ Example: `{username: "foo", title: "bar", about: "This is an example bio"}`
|
||||
|
||||
|
||||
|
||||
## Not Yet Implemented
|
||||
|
||||
#### /api/user/streamkey/current
|
||||
|
||||
Return current stream key
|
||||
Returns current stream key for the authenticated user.
|
||||
|
||||
Method: GET
|
||||
|
||||
Authentication: yes
|
||||
|
||||
Parameters: none
|
||||
|
||||
Response: returns a JSON object with the stream key
|
||||
|
||||
Example: `{"stream_key": "abcdefghijklmno12345"}` or `{"error":"error reason"}`
|
Reference in New Issue
Block a user