docs/api/index.html
External
Internal
Auth
Chat
Objects
Video
Notifications
Social
Admin
Download OpenAPI specification:
Gabe Kangas: [email protected] URL: http://owncast.online License: MIT
Internal The APIs required to make the Owncast web interface and internal functionality work. These APIs will never reach stability and will always change as Owncast features and functionality change. This means these endpoints are not good options to build your own tooling and features on top of. You can, however, of course can if that risk is acceptable to you.
Admin The APIs used to configure the Owncast server, as well as power the web admin interface. These APIs are protected by the admin password, using HTTP Basic authentication. They should not be used by external tools or integrations as it would require you to give your admin password to a third party.
These APIs are specifically exposed for building third party applications or tooling. They use auth tokens to authenticate and are designed to be stable and reliable.
BearerAuth
The content of the system message
| body |
string
|
200
Message sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BearerAuth
| clientId required |
integer
The ID of the specified client
|
| timestamp |
string
| | type |
string
| | id |
string
| | body |
string
|
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
Content type application/json
Copy
`{
"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BearerAuth
400
Bad request
post/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BearerAuth
| body |
string
|
200
Message sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
BearerAuth
| body |
string
|
200
Action sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BearerAuth
| idArray |
Array of strings
| | visible |
boolean
|
200
Messages updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
BearerAuth
200
Status
401
Basic auth failure
404
Not found
default
Unexpected error
get/integrations/status
Localhost port 8080
http://localhost:8080/api/integrations/status
Content type application/json
Copy
`{
"serverTime": "string",
"lastConnectTime": "string",
"lastDisconnectTime": "string",
"versionNumber": "string",
"viewerCount": 0,
"online": true,
"streamTitle": "string"
}`
BearerAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream title has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/integrations/streamtitle
Localhost port 8080
http://localhost:8080/api/integrations/streamtitle
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/streamtitle
Localhost port 8080
http://localhost:8080/api/integrations/streamtitle
BearerAuth
200
List of chat messages
401
Unauthorized
501
Not Implemented
default
Unexpected error
get/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
204
No Content
options/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
BearerAuth
200
List of chat clients
400
Bad request
401
Basic auth failure
default
Unexpected error
get/integrations/clients
Localhost port 8080
http://localhost:8080/api/integrations/clients
Content type application/json
Copy Expand all Collapse all
`[ {
"connectedAt": "2019-08-24T14:15:22Z",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"messageCount": 0
}
]`
204
No Content
options/integrations/clients
Localhost port 8080
http://localhost:8080/api/integrations/clients
BearerAuth
| userId required |
string
The ID of the user to find
|
200
User information
401
Basic auth failure
404
Not found
default
Unexpected error
get/integrations/moderation/chat/user/{userId}
Localhost port 8080
http://localhost:8080/api/integrations/moderation/chat/user/{userId}
Content type application/json
Copy Expand all Collapse all
`{
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"connectedClients": [ {
"connectedAt": "2019-08-24T14:15:22Z",
"userAgent": "string",
"geo": "string",
"id": 0,
"messageCount": 0
}
],
"messages": [ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]
}`
These APIs are used internally for the operation of the application. They should not be used by third party clients or tooling, as they may require sharing your admin password, and additionally may change at any time.
200
Successful response
get/status
Localhost port 8080
http://localhost:8080/api/status
Content type application/json
Copy
`{
"serverTime": "string",
"lastConnectTime": "string",
"lastDisconnectTime": "string",
"versionNumber": "string",
"viewerCount": 0,
"online": true,
"streamTitle": "string"
}`
200
List of valid emojis
500
Internal Server Error
get/emoji
Localhost port 8080
http://localhost:8080/api/emoji
Content type application/json
Copy Expand all Collapse all
`[ {
"name": "string",
"url": "string"
}
]`
| accessToken required |
string
|
200
List of chat messages
401
Unauthorized
501
Not Implemented
get/chat
Localhost port 8080
http://localhost:8080/api/chat
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
| X-Forwarded-User |
string
|
The display name of the new user
| displayName |
string
|
200
Anonymous user information
400
Bad request
post/chat/register
Localhost port 8080
http://localhost:8080/api/chat/register
Content type application/json
Copy
`{ "displayName": "string"
}`
Content type application/json
Copy
`{
"id": "string",
"accessToken": "string",
"displayName": "string"
}`
| accessToken required |
string
|
| idArray |
Array of strings
| | visible |
boolean
|
200
Message visibility updated
400
Bad request
401
Unauthorized
default
Unexpected error
post/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| accessToken required |
string
|
| userId |
string
| | enabled |
boolean
|
200
User status has been updated
400
Bad request
401
Unauthorized
default
Unexpected error
post/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/chat/users/setenabled
Content type application/json
Copy
`{
"userId": "string",
"enabled": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
200
The current web config
500
Internal Server Error
get/config
Localhost port 8080
http://localhost:8080/api/config
Content type application/json
Copy Expand all Collapse all
`{
"appearanceVariables": {
"property1": "string",
"property2": "string"
},
"name": "string",
"customStyles": "string",
"streamTitle": "string",
"offlineMessage": "string",
"logo": "string",
"version": "string",
"socketHostOverride": "string",
"extraPageContent": "string",
"summary": "string",
"tags": ["string" ],
"socialHandles": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
],
"externalActions": [ {
"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
],
"notifications": { "browser": {
"publicKey": "string",
"enabled": true
}
},
"federation": {
"account": "string",
"followerCount": 0,
"enabled": true
},
"maxSocketPayloadSize": 0,
"hideViewerCount": true,
"chatDisabled": true,
"chatRequireAuthentication": true,
"nsfw": true,
"authentication": { "indieAuthEnabled": true
}
}`
200
The current YP protocol configuration
404
Not found
get/yp
Localhost port 8080
Content type application/json
Copy Expand all Collapse all
`{
"lastConnectTime": "string",
"name": "string",
"description": "string",
"streamTitle": "string",
"logo": "string",
"tags": ["string" ],
"social": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
],
"viewerCount": 0,
"overallMaxViewerCount": 0,
"sessionMaxViewerCount": 0,
"nsfw": true,
"online": true
}`
200
The list of social platforms
500
Internal Server Error
get/socialplatforms
Localhost port 8080
http://localhost:8080/api/socialplatforms
Content type application/json
Copy Expand all Collapse all
`{
"property1": {
"platform": "string",
"url": "string",
"icon": "string"
},
"property2": {
"platform": "string",
"url": "string",
"icon": "string"
}
}`
200
List of available video variants
get/video/variants
Localhost port 8080
http://localhost:8080/api/video/variants
Content type application/json
Copy Expand all Collapse all
`[ {
"index": 0,
"name": "string"
}
]`
200
Added as an active viewer
get/ping
Localhost port 8080
http://localhost:8080/api/ping
| account |
string
|
200
Contains redirect URL remote follow follow
400
Bad request
post/remotefollow
Localhost port 8080
http://localhost:8080/api/remotefollow
Content type application/json
Copy
`{ "account": "string"
}`
Content type application/json
Copy
`{ "redirectUrl": "string"
}`
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
Paginated follower count
400
Bad request
get/followers
Localhost port 8080
http://localhost:8080/api/followers
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": [ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}`
Video metrics to record
| bandwidth |
number <double>
| | latency |
number <double>
| | errors |
number <double>
| | downloadDuration |
number <double>
| | qualityVariantChanges |
number <double>
|
200
Metrics successfully recorded
400
Bad request
post/metrics/playback
Localhost port 8080
http://localhost:8080/api/metrics/playback
Content type application/json
Copy
`{
"bandwidth": 0.1,
"latency": 0.1,
"errors": 0.1,
"downloadDuration": 0.1,
"qualityVariantChanges": 0.1
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| accessToken required |
string
|
Information for notification
| channel |
string
Name of notification channel
| | destination |
string
Target of the notification in the channel
|
200
Successfully added notification channel
400
Bad request
401
Unauthorized
post/notifications/register
Localhost port 8080
http://localhost:8080/api/notifications/register
Content type application/json
Copy
`{
"channel": "string",
"destination": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
Gives the status of the system
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/status
Localhost port 8080
http://localhost:8080/api/admin/status
Content type application/json
Copy Expand all Collapse all
`{
"broadcaster": {
"time": "2019-08-24T14:15:22Z",
"remoteAddr": "string",
"streamDetails": {
"videoCodec": "string",
"audioCodec": "string",
"encoder": "string",
"width": 0,
"height": 0,
"videoBitrate": 0,
"audioBitrate": 0,
"framerate": 0.1
}
},
"currentBroadcast": {
"outputSettings": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
],
"latencyLevel": { "level": 0
}
},
"health": {
"message": "string",
"healthPercentage": 0,
"representation": 0,
"healthy": true
},
"streamTitle": "string",
"versionNumber": "string",
"viewerCount": 0,
"overallPeakViewerCount": 0,
"sessionPeakViewerCount": 0,
"online": true
}`
BasicAuth
200
Contains information about disconnection status
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/disconnect
Localhost port 8080
http://localhost:8080/api/admin/disconnect
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
Current server config
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/serverconfig
Localhost port 8080
http://localhost:8080/api/admin/serverconfig
Content type application/json
Copy Expand all Collapse all
`{
"instanceDetails": {
"appearanceVariables": {
"property1": "string",
"property2": "string"
},
"version": "string",
"welcomeMessage": "string",
"offlineMessage": "string",
"logo": "string",
"name": "string",
"extraPageContent": "string",
"streamTitle": "string",
"customStyles": "string",
"customJavascript": "string",
"summary": "string",
"tags": ["string" ],
"socialHandles": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
],
"nsfw": true
},
"notifications": {
"browser": {
"goLiveMessage": "string",
"enabled": true
},
"discord": {
"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
},
"yp": {
"instanceUrl": "string",
"enabled": true
},
"ffmpegPath": "string",
"adminPassword": "string",
"socketHostOverride": "string",
"webServerIP": "string",
"videoCodec": "string",
"videoServingEndpoint": "string",
"s3": {
"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
},
"federation": {
"username": "string",
"goLiveMessage": "string",
"blockedDomains": ["string" ],
"enabled": true,
"isPrivate": true,
"showEngagement": true
},
"supportedCodecs": ["string" ],
"externalActions": [ {
"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
],
"forbiddenUsernames": ["string" ],
"suggestedUsernames": ["string" ],
"streamKeys": [ {
"key": "string",
"comment": "string"
}
],
"videoSettings": {
"videoQualityVariants": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
],
"latencyLevel": 0
},
"rtmpServerPort": 0,
"webServerPort": 0,
"chatDisabled": true,
"chatJoinMessagesEnabled": true,
"chatEstablishedUserMode": true,
"disableSearchIndexing": true,
"streamKeyOverridden": true,
"hideViewerCount": true
}`
BasicAuth
| windowStart |
string
Start date in unix time
|
200
Viewer count over time
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/viewersOverTime
Localhost port 8080
http://localhost:8080/api/admin/viewersOverTime
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]`
BasicAuth
200
List of active viewers
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/viewers
Localhost port 8080
http://localhost:8080/api/admin/viewers
Content type application/json
Copy Expand all Collapse all
`[ {
"firstSeen": "2019-08-24T14:15:22Z",
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"ipAddress": "string",
"clientID": "string"
}
]`
BasicAuth
200
Current hardware stats
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/hardwarestats
Localhost port 8080
http://localhost:8080/api/admin/hardwarestats
Content type application/json
Copy Expand all Collapse all
`{
"message": "string",
"healthPercentage": 0,
"representation": 0,
"healthy": true,
"disk": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"memory": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"cpu": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]
}`
BasicAuth
200
List of chat clients
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/clients
Localhost port 8080
http://localhost:8080/api/admin/chat/clients
Content type application/json
Copy Expand all Collapse all
`[ {
"connectedAt": "2019-08-24T14:15:22Z",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"messageCount": 0
}
]`
BasicAuth
200
List of chat messages for the admin
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/messages
Localhost port 8080
http://localhost:8080/api/admin/chat/messages
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
BasicAuth
| idArray |
Array of strings
| | visible |
boolean
|
200
Messages updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/admin/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| userId |
string
| | enabled |
boolean
|
200
Successfully updated the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setenabled
Content type application/json
Copy
`{
"userId": "string",
"enabled": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of disabled users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/disabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/disabled
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
IP was successfully banned
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/create
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/create
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| value |
string or boolean or Array of strings or number
|
200
IP ban was successfully removed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/remove
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/remove
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of banned IP addresses
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/ipbans
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]`
BasicAuth
| userId |
string
| | isModerator |
boolean
|
200
Successfully update the moderator status of the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setmoderator
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setmoderator
Content type application/json
Copy
`{
"userId": "string",
"isModerator": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of moderator users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
204
No Content
options/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
BasicAuth
200
List of logs
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/logs
Localhost port 8080
http://localhost:8080/api/admin/logs
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]`
204
No Content
options/admin/logs
Localhost port 8080
http://localhost:8080/api/admin/logs
BasicAuth
200
List of warnings and errors
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/logs/warnings
Localhost port 8080
http://localhost:8080/api/admin/logs/warnings
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]`
204
No Content
options/admin/logs/warnings
Localhost port 8080
http://localhost:8080/api/admin/logs/warnings
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
Paginated follower count
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": [ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}`
204
No Content
options/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
BasicAuth
200
List of pending followers
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
BasicAuth
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
BasicAuth
| actorIRI |
string
| | approved |
boolean
|
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
Content type application/json
Copy
`{
"actorIRI": "string",
"approved": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
BasicAuth
| name |
string
| | data |
string
Base 64 encoded image data
|
200
Emoji has been uploaded
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
Content type application/json
Copy
`{
"name": "string",
"data": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
BasicAuth
| name |
string
|
200
Emoji has been deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
Content type application/json
Copy
`{ "name": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Admin password has been updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/adminpass
Localhost port 8080
http://localhost:8080/api/admin/config/adminpass
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/adminpass
Localhost port 8080
http://localhost:8080/api/admin/config/adminpass
BasicAuth
| value |
Array of objects (StreamKey)
|
200
Stream keys have been updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/streamkeys
Localhost port 8080
http://localhost:8080/api/admin/config/streamkeys
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"key": "string",
"comment": "string"
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/streamkeys
Localhost port 8080
http://localhost:8080/api/admin/config/streamkeys
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Page content has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/pagecontent
Localhost port 8080
http://localhost:8080/api/admin/config/pagecontent
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/pagecontent
Localhost port 8080
http://localhost:8080/api/admin/config/pagecontent
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream title has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/streamtitle
Localhost port 8080
http://localhost:8080/api/admin/config/streamtitle
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/streamtitle
Localhost port 8080
http://localhost:8080/api/admin/config/streamtitle
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server name has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server summary has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Offline message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Welcome message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat has been disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
User join messages has been enabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat established user mode updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
BasicAuth
| value |
Array of strings
|
200
Forbidden usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
BasicAuth
| value |
Array of strings
|
200
Suggested usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Spam protection enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Slur filter enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Require authentication setting updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video codec updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream latency updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
BasicAuth
| value |
Array of objects (StreamOutputVariant)
|
200
Stream Output Variants updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
BasicAuth
| value |
object
|
200
Appearance updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/appearance
Localhost port 8080
http://localhost:8080/api/admin/config/appearance
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"property1": "string",
"property2": "string"
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/appearance
Localhost port 8080
http://localhost:8080/api/admin/config/appearance
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Logo updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/logo
Localhost port 8080
http://localhost:8080/api/admin/config/logo
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/logo
Localhost port 8080
http://localhost:8080/api/admin/config/logo
BasicAuth
| favicon |
string <binary>
Favicon file (PNG or ICO, max 200KB)
|
200
Favicon updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
Favicon reset to default
401
Basic auth failure
default
Unexpected error
delete/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Tags updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/tags
Localhost port 8080
http://localhost:8080/api/admin/config/tags
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/tags
Localhost port 8080
http://localhost:8080/api/admin/config/tags
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Path updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/ffmpegpath
Localhost port 8080
http://localhost:8080/api/admin/config/ffmpegpath
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/ffmpegpath
Localhost port 8080
http://localhost:8080/api/admin/config/ffmpegpath
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Port updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/webserverport
Localhost port 8080
http://localhost:8080/api/admin/config/webserverport
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/webserverport
Localhost port 8080
http://localhost:8080/api/admin/config/webserverport
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
IP Address updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/webserverip
Localhost port 8080
http://localhost:8080/api/admin/config/webserverip
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/webserverip
Localhost port 8080
http://localhost:8080/api/admin/config/webserverip
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
RTMP port updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Websocket host override updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video Serving Endpoint updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
NSFW status updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/nsfw
Localhost port 8080
http://localhost:8080/api/admin/config/nsfw
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/nsfw
Localhost port 8080
http://localhost:8080/api/admin/config/nsfw
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Directory Enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/directoryenabled
Localhost port 8080
http://localhost:8080/api/admin/config/directoryenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/directoryenabled
Localhost port 8080
http://localhost:8080/api/admin/config/directoryenabled
BasicAuth
| value |
Array of objects (SocialHandle)
|
200
Social handles updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/socialhandles
Localhost port 8080
http://localhost:8080/api/admin/config/socialhandles
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/socialhandles
Localhost port 8080
http://localhost:8080/api/admin/config/socialhandles
BasicAuth
| value |
object (S3Info)
|
200
Directory Enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server URL updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/serverurl
Localhost port 8080
http://localhost:8080/api/admin/config/serverurl
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/serverurl
Localhost port 8080
http://localhost:8080/api/admin/config/serverurl
BasicAuth
| value |
Array of objects (ExternalAction)
|
200
External Action Links updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/externalactions
Localhost port 8080
http://localhost:8080/api/admin/config/externalactions
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/externalactions
Localhost port 8080
http://localhost:8080/api/admin/config/externalactions
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Custom styles updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/customstyles
Localhost port 8080
http://localhost:8080/api/admin/config/customstyles
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/customstyles
Localhost port 8080
http://localhost:8080/api/admin/config/customstyles
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Custom JavaScript updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/customjavascript
Localhost port 8080
http://localhost:8080/api/admin/config/customjavascript
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/customjavascript
Localhost port 8080
http://localhost:8080/api/admin/config/customjavascript
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Hide viewer count updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/hideviewercount
Localhost port 8080
http://localhost:8080/api/admin/config/hideviewercount
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/hideviewercount
Localhost port 8080
http://localhost:8080/api/admin/config/hideviewercount
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Search Indexing updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/disablesearchindexing
Localhost port 8080
http://localhost:8080/api/admin/config/disablesearchindexing
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/disablesearchindexing
Localhost port 8080
http://localhost:8080/api/admin/config/disablesearchindexing
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation features enabled/disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Private status set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation engagement set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation blocked domains set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
BasicAuth
| value |
object (DiscordNotificationConfiguration)
|
200
Discord notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
BasicAuth
| value |
object (BrowserNotificationConfiguration)
|
200
Browser notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
BasicAuth
200
All webhooks
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}
]`
204
No Content
options/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
BasicAuth
| id |
integer
|
200
Webhook successfully deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
Content type application/json
Copy
`{ "id": 0
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
BasicAuth
| url |
string
| | events |
Array of strings (WebhookEventType)
Items Enum: "CHAT" "USER_JOINED" "USER_PARTED" "NAME_CHANGE" "VISIBILITY-UPDATE" "PING" "PONG" "STREAM_STARTED" "STREAM_STOPPED" "STREAM_TITLE_UPDATED" "SYSTEM" "CHAT_ACTION"
|
200
The new webhook
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
Content type application/json
Copy Expand all Collapse all
`{
"url": "string",
"events": ["CHAT" ]
}`
Content type application/json
Copy Expand all Collapse all
`{
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}`
204
No Content
options/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
BasicAuth
200
List of external API users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/accesstokens
Localhost port 8080
http://localhost:8080/api/admin/accesstokens
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"id": "string",
"accessToken": "string",
"displayName": "string",
"type": "string",
"scopes": ["string" ],
"displayColor": 0,
"isBot": true
}
]`
204
No Content
options/admin/accesstokens
Localhost port 8080
http://localhost:8080/api/admin/accesstokens
BasicAuth
| token |
string
|
200
External API user successfully deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/accesstokens/delete
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/delete
Content type application/json
Copy
`{ "token": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/accesstokens/delete
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/delete
BasicAuth
| name |
string
| | scopes |
Array of strings
|
200
The new external API user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/accesstokens/create
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/create
Content type application/json
Copy Expand all Collapse all
`{
"name": "string",
"scopes": ["string" ]
}`
Content type application/json
Copy Expand all Collapse all
`{
"createdAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"id": "string",
"accessToken": "string",
"displayName": "string",
"type": "string",
"scopes": ["string" ],
"displayColor": 0,
"isBot": true
}`
204
No Content
options/admin/accesstokens/create
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/create
BasicAuth
200
Current auto-update options
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/options
Localhost port 8080
http://localhost:8080/api/admin/update/options
Content type application/json
Copy
`{
"supportsUpdate": true,
"canRestart": true
}`
204
No Content
options/admin/update/options
Localhost port 8080
http://localhost:8080/api/admin/update/options
BasicAuth
200
Console output from update
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/start
Localhost port 8080
http://localhost:8080/api/admin/update/start
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/update/start
Localhost port 8080
http://localhost:8080/api/admin/update/start
BasicAuth
200
Server force restart has been ordered
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/forcequit
Localhost port 8080
http://localhost:8080/api/admin/update/forcequit
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/update/forcequit
Localhost port 8080
http://localhost:8080/api/admin/update/forcequit
BasicAuth
200
YP Registration has been reset
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/yp/reset
Localhost port 8080
http://localhost:8080/api/admin/yp/reset
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/yp/reset
Localhost port 8080
http://localhost:8080/api/admin/yp/reset
BasicAuth
200
Video playback metrics
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
Content type application/json
Copy Expand all Collapse all
`{
"errors": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"qualityVariantChanges": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"highestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"lowestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maximumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minimumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maxPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"availableBitrates": [0 ],
"segmentLength": 0,
"representation": 0
}`
204
No Content
options/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
get/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
post/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
put/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
delete/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
options/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Message sent
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
A paginated list of federated activities
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": {
"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}`
204
No Content
options/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
204
No Content
options/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
| clientId required |
integer
The ID of the specified client
|
204
No Content
options/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
204
No Content
options/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
204
No Content
options/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
| accessToken required |
string
|
| authHost |
string
|
200
Authentication redirect
400
Bad request
401
Unauthorized
default
Unexpected error
post/auth/indieauth
Localhost port 8080
http://localhost:8080/api/auth/indieauth
Content type application/json
Copy
`{ "authHost": "string"
}`
Content type application/json
Copy
`{ "redirect": "string"
}`
| state required |
string
|
307
Redirected to home page
400
Bad request
get/auth/indieauth/callback
Localhost port 8080
http://localhost:8080/api/auth/indieauth/callback
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| client_id required |
string
| | redirect_uri required |
string
| | code_challenge required |
string
| | state required |
string
|
200
IndieAuth flow concluded
307
Redirected to redirect URI
400
Bad request
500
Internal Server Error
get/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
Form submission from IndieAuth
| code |
string
| | redirect_uri |
string
| | client_id |
string
| | codeVerifier |
string
|
200
IndieAuth flow concluded
400
Bad request
post/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Example IndieAuthResponseIndieAuthServerProfileResponseIndieAuthResponse
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
| accessToken required |
string
|
| account |
string
|
200
OTP sent
400
Bad request
401
Unauthorized
post/auth/fediverse
Localhost port 8080
http://localhost:8080/api/auth/fediverse
Content type application/json
Copy
`{ "account": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| code |
string
|
200
OTP Verified
400
Bad request
403
Forbidden
post/auth/fediverse/verify
Localhost port 8080
http://localhost:8080/api/auth/fediverse/verify
Content type application/json
Copy
`{ "code": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
Authentication API
| accessToken required |
string
|
| authHost |
string
|
200
Authentication redirect
400
Bad request
401
Unauthorized
default
Unexpected error
post/auth/indieauth
Localhost port 8080
http://localhost:8080/api/auth/indieauth
Content type application/json
Copy
`{ "authHost": "string"
}`
Content type application/json
Copy
`{ "redirect": "string"
}`
| state required |
string
|
307
Redirected to home page
400
Bad request
get/auth/indieauth/callback
Localhost port 8080
http://localhost:8080/api/auth/indieauth/callback
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| client_id required |
string
| | redirect_uri required |
string
| | code_challenge required |
string
| | state required |
string
|
200
IndieAuth flow concluded
307
Redirected to redirect URI
400
Bad request
500
Internal Server Error
get/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
Form submission from IndieAuth
| code |
string
| | redirect_uri |
string
| | client_id |
string
| | codeVerifier |
string
|
200
IndieAuth flow concluded
400
Bad request
post/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Example IndieAuthResponseIndieAuthServerProfileResponseIndieAuthResponse
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
| accessToken required |
string
|
| account |
string
|
200
OTP sent
400
Bad request
401
Unauthorized
post/auth/fediverse
Localhost port 8080
http://localhost:8080/api/auth/fediverse
Content type application/json
Copy
`{ "account": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| code |
string
|
200
OTP Verified
400
Bad request
403
Forbidden
post/auth/fediverse/verify
Localhost port 8080
http://localhost:8080/api/auth/fediverse/verify
Content type application/json
Copy
`{ "code": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
APIs related to operating the chat system.
200
List of valid emojis
500
Internal Server Error
get/emoji
Localhost port 8080
http://localhost:8080/api/emoji
Content type application/json
Copy Expand all Collapse all
`[ {
"name": "string",
"url": "string"
}
]`
| accessToken required |
string
|
200
List of chat messages
401
Unauthorized
501
Not Implemented
get/chat
Localhost port 8080
http://localhost:8080/api/chat
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
| X-Forwarded-User |
string
|
The display name of the new user
| displayName |
string
|
200
Anonymous user information
400
Bad request
post/chat/register
Localhost port 8080
http://localhost:8080/api/chat/register
Content type application/json
Copy
`{ "displayName": "string"
}`
Content type application/json
Copy
`{
"id": "string",
"accessToken": "string",
"displayName": "string"
}`
204
No Content
options/chat/register
Localhost port 8080
http://localhost:8080/api/chat/register
| accessToken required |
string
|
| idArray |
Array of strings
| | visible |
boolean
|
200
Message visibility updated
400
Bad request
401
Unauthorized
default
Unexpected error
post/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| accessToken required |
string
|
| userId |
string
| | enabled |
boolean
|
200
User status has been updated
400
Bad request
401
Unauthorized
default
Unexpected error
post/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/chat/users/setenabled
Content type application/json
Copy
`{
"userId": "string",
"enabled": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of chat clients
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/clients
Localhost port 8080
http://localhost:8080/api/admin/chat/clients
Content type application/json
Copy Expand all Collapse all
`[ {
"connectedAt": "2019-08-24T14:15:22Z",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"messageCount": 0
}
]`
204
No Content
options/admin/chat/clients
Localhost port 8080
http://localhost:8080/api/admin/chat/clients
BasicAuth
200
List of chat messages for the admin
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/messages
Localhost port 8080
http://localhost:8080/api/admin/chat/messages
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
204
No Content
options/admin/chat/messages
Localhost port 8080
http://localhost:8080/api/admin/chat/messages
BasicAuth
| idArray |
Array of strings
| | visible |
boolean
|
200
Messages updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/admin/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/admin/chat/messagevisibility
BasicAuth
| userId |
string
| | enabled |
boolean
|
200
Successfully updated the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setenabled
Content type application/json
Copy
`{
"userId": "string",
"enabled": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setenabled
BasicAuth
200
List of disabled users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/disabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/disabled
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
204
No Content
options/admin/chat/users/disabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/disabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
IP was successfully banned
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/create
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/create
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/chat/users/ipbans/create
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/create
BasicAuth
| value |
string or boolean or Array of strings or number
|
200
IP ban was successfully removed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/remove
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/remove
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/chat/users/ipbans/remove
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/remove
BasicAuth
200
List of banned IP addresses
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/ipbans
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]`
204
No Content
options/admin/chat/users/ipbans
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans
BasicAuth
| userId |
string
| | isModerator |
boolean
|
200
Successfully update the moderator status of the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setmoderator
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setmoderator
Content type application/json
Copy
`{
"userId": "string",
"isModerator": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/chat/users/setmoderator
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setmoderator
BasicAuth
200
List of moderator users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
BasicAuth
| name |
string
| | data |
string
Base 64 encoded image data
|
200
Emoji has been uploaded
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
Content type application/json
Copy
`{
"name": "string",
"data": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
BasicAuth
| name |
string
|
200
Emoji has been deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
Content type application/json
Copy
`{ "name": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Welcome message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat has been disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
User join messages has been enabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat established user mode updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
BasicAuth
| value |
Array of strings
|
200
Forbidden usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
BasicAuth
| value |
Array of strings
|
200
Suggested usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Spam protection enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Slur filter enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Require authentication setting updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Websocket host override updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
BearerAuth
The content of the system message
| body |
string
|
200
Message sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
BearerAuth
| clientId required |
integer
The ID of the specified client
|
| timestamp |
string
| | type |
string
| | id |
string
| | body |
string
|
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
Content type application/json
Copy
`{
"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| clientId required |
integer
The ID of the specified client
|
204
No Content
options/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
BearerAuth
400
Bad request
post/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
BearerAuth
| body |
string
|
200
Message sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
BearerAuth
| body |
string
|
200
Action sent successfully
400
Bad request
401
Unauthorized
500
Internal Server Error
default
Unexpected error
post/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
Content type application/json
Copy
`{ "body": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
BearerAuth
| idArray |
Array of strings
| | visible |
boolean
|
200
Messages updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
BearerAuth
200
List of chat messages
401
Unauthorized
501
Not Implemented
default
Unexpected error
get/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
204
No Content
options/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
BearerAuth
200
List of chat clients
400
Bad request
401
Basic auth failure
default
Unexpected error
get/integrations/clients
Localhost port 8080
http://localhost:8080/api/integrations/clients
Content type application/json
Copy Expand all Collapse all
`[ {
"connectedAt": "2019-08-24T14:15:22Z",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"messageCount": 0
}
]`
204
No Content
options/integrations/clients
Localhost port 8080
http://localhost:8080/api/integrations/clients
BearerAuth
| userId required |
string
The ID of the user to find
|
200
User information
401
Basic auth failure
404
Not found
default
Unexpected error
get/integrations/moderation/chat/user/{userId}
Localhost port 8080
http://localhost:8080/api/integrations/moderation/chat/user/{userId}
Content type application/json
Copy Expand all Collapse all
`{
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"connectedClients": [ {
"connectedAt": "2019-08-24T14:15:22Z",
"userAgent": "string",
"geo": "string",
"id": 0,
"messageCount": 0
}
],
"messages": [ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]
}`
| userId required |
string
The ID of the user to find
|
| accessToken required |
string
|
200
User information
401
Unauthorized
404
Not found
default
Unexpected error
get/moderation/chat/user/{userId}
Localhost port 8080
http://localhost:8080/api/moderation/chat/user/{userId}
Content type application/json
Copy Expand all Collapse all
`{
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"connectedClients": [ {
"connectedAt": "2019-08-24T14:15:22Z",
"userAgent": "string",
"geo": "string",
"id": 0,
"messageCount": 0
}
],
"messages": [ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]
}`
| accessToken required |
string
|
| authHost |
string
|
200
Authentication redirect
400
Bad request
401
Unauthorized
default
Unexpected error
post/auth/indieauth
Localhost port 8080
http://localhost:8080/api/auth/indieauth
Content type application/json
Copy
`{ "authHost": "string"
}`
Content type application/json
Copy
`{ "redirect": "string"
}`
| state required |
string
|
307
Redirected to home page
400
Bad request
get/auth/indieauth/callback
Localhost port 8080
http://localhost:8080/api/auth/indieauth/callback
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| client_id required |
string
| | redirect_uri required |
string
| | code_challenge required |
string
| | state required |
string
|
200
IndieAuth flow concluded
307
Redirected to redirect URI
400
Bad request
500
Internal Server Error
get/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
Form submission from IndieAuth
| code |
string
| | redirect_uri |
string
| | client_id |
string
| | codeVerifier |
string
|
200
IndieAuth flow concluded
400
Bad request
post/auth/provider/indieauth
Localhost port 8080
http://localhost:8080/api/auth/provider/indieauth
Content type application/json
Example IndieAuthResponseIndieAuthServerProfileResponseIndieAuthResponse
Copy Expand all Collapse all
`{
"me": "string",
"profile": {
"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}`
| accessToken required |
string
|
| account |
string
|
200
OTP sent
400
Bad request
401
Unauthorized
post/auth/fediverse
Localhost port 8080
http://localhost:8080/api/auth/fediverse
Content type application/json
Copy
`{ "account": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
| code |
string
|
200
OTP Verified
400
Bad request
403
Forbidden
post/auth/fediverse/verify
Localhost port 8080
http://localhost:8080/api/auth/fediverse/verify
Content type application/json
Copy
`{ "code": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
Object definitions
204
No Content
options/chat/register
Localhost port 8080
http://localhost:8080/api/chat/register
204
No Content
options/admin/status
Localhost port 8080
http://localhost:8080/api/admin/status
204
No Content
options/admin/disconnect
Localhost port 8080
http://localhost:8080/api/admin/disconnect
204
No Content
options/admin/serverconfig
Localhost port 8080
http://localhost:8080/api/admin/serverconfig
204
No Content
options/admin/viewersOverTime
Localhost port 8080
http://localhost:8080/api/admin/viewersOverTime
204
No Content
options/admin/viewers
Localhost port 8080
http://localhost:8080/api/admin/viewers
204
No Content
options/admin/hardwarestats
Localhost port 8080
http://localhost:8080/api/admin/hardwarestats
204
No Content
options/admin/chat/clients
Localhost port 8080
http://localhost:8080/api/admin/chat/clients
204
No Content
options/admin/chat/messages
Localhost port 8080
http://localhost:8080/api/admin/chat/messages
204
No Content
options/admin/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/admin/chat/messagevisibility
204
No Content
options/admin/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setenabled
204
No Content
options/admin/chat/users/disabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/disabled
204
No Content
options/admin/chat/users/ipbans/create
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/create
204
No Content
options/admin/chat/users/ipbans/remove
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/remove
204
No Content
options/admin/chat/users/ipbans
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans
204
No Content
options/admin/chat/users/setmoderator
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setmoderator
204
No Content
options/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
204
No Content
options/admin/logs
Localhost port 8080
http://localhost:8080/api/admin/logs
204
No Content
options/admin/logs/warnings
Localhost port 8080
http://localhost:8080/api/admin/logs/warnings
204
No Content
options/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
204
No Content
options/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
204
No Content
options/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
204
No Content
options/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
204
No Content
options/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
204
No Content
options/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
204
No Content
options/admin/config/adminpass
Localhost port 8080
http://localhost:8080/api/admin/config/adminpass
204
No Content
options/admin/config/streamkeys
Localhost port 8080
http://localhost:8080/api/admin/config/streamkeys
204
No Content
options/admin/config/pagecontent
Localhost port 8080
http://localhost:8080/api/admin/config/pagecontent
204
No Content
options/admin/config/streamtitle
Localhost port 8080
http://localhost:8080/api/admin/config/streamtitle
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server name has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server summary has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Offline message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
204
No Content
options/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
204
No Content
options/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
204
No Content
options/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
204
No Content
options/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
204
No Content
options/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
204
No Content
options/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
204
No Content
options/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
204
No Content
options/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
204
No Content
options/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
204
No Content
options/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
204
No Content
options/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
204
No Content
options/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
204
No Content
options/admin/config/appearance
Localhost port 8080
http://localhost:8080/api/admin/config/appearance
204
No Content
options/admin/config/logo
Localhost port 8080
http://localhost:8080/api/admin/config/logo
204
No Content
options/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
204
No Content
options/admin/config/tags
Localhost port 8080
http://localhost:8080/api/admin/config/tags
204
No Content
options/admin/config/ffmpegpath
Localhost port 8080
http://localhost:8080/api/admin/config/ffmpegpath
204
No Content
options/admin/config/webserverport
Localhost port 8080
http://localhost:8080/api/admin/config/webserverport
204
No Content
options/admin/config/webserverip
Localhost port 8080
http://localhost:8080/api/admin/config/webserverip
204
No Content
options/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
204
No Content
options/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
204
No Content
options/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
204
No Content
options/admin/config/nsfw
Localhost port 8080
http://localhost:8080/api/admin/config/nsfw
204
No Content
options/admin/config/directoryenabled
Localhost port 8080
http://localhost:8080/api/admin/config/directoryenabled
204
No Content
options/admin/config/socialhandles
Localhost port 8080
http://localhost:8080/api/admin/config/socialhandles
204
No Content
options/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
204
No Content
options/admin/config/serverurl
Localhost port 8080
http://localhost:8080/api/admin/config/serverurl
204
No Content
options/admin/config/externalactions
Localhost port 8080
http://localhost:8080/api/admin/config/externalactions
204
No Content
options/admin/config/customstyles
Localhost port 8080
http://localhost:8080/api/admin/config/customstyles
204
No Content
options/admin/config/customjavascript
Localhost port 8080
http://localhost:8080/api/admin/config/customjavascript
204
No Content
options/admin/config/hideviewercount
Localhost port 8080
http://localhost:8080/api/admin/config/hideviewercount
204
No Content
options/admin/config/disablesearchindexing
Localhost port 8080
http://localhost:8080/api/admin/config/disablesearchindexing
204
No Content
options/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
204
No Content
options/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
204
No Content
options/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
204
No Content
options/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
204
No Content
options/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
204
No Content
options/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
204
No Content
options/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
204
No Content
options/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
204
No Content
options/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
204
No Content
options/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
204
No Content
options/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
204
No Content
options/admin/accesstokens
Localhost port 8080
http://localhost:8080/api/admin/accesstokens
204
No Content
options/admin/accesstokens/delete
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/delete
204
No Content
options/admin/accesstokens/create
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/create
204
No Content
options/admin/update/options
Localhost port 8080
http://localhost:8080/api/admin/update/options
204
No Content
options/admin/update/start
Localhost port 8080
http://localhost:8080/api/admin/update/start
204
No Content
options/admin/update/forcequit
Localhost port 8080
http://localhost:8080/api/admin/update/forcequit
204
No Content
options/admin/yp/reset
Localhost port 8080
http://localhost:8080/api/admin/yp/reset
204
No Content
options/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
204
No Content
options/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
204
No Content
options/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
204
No Content
options/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
| clientId required |
integer
The ID of the specified client
|
204
No Content
options/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
204
No Content
options/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
204
No Content
options/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
204
No Content
options/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
204
No Content
options/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
204
No Content
options/integrations/streamtitle
Localhost port 8080
http://localhost:8080/api/integrations/streamtitle
204
No Content
options/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
204
No Content
options/integrations/clients
Localhost port 8080
http://localhost:8080/api/integrations/clients
Video API
200
List of available video variants
get/video/variants
Localhost port 8080
http://localhost:8080/api/video/variants
Content type application/json
Copy Expand all Collapse all
`[ {
"index": 0,
"name": "string"
}
]`
200
Added as an active viewer
get/ping
Localhost port 8080
http://localhost:8080/api/ping
BasicAuth
200
Contains information about disconnection status
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/disconnect
Localhost port 8080
http://localhost:8080/api/admin/disconnect
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/disconnect
Localhost port 8080
http://localhost:8080/api/admin/disconnect
204
No Content
options/admin/viewers
Localhost port 8080
http://localhost:8080/api/admin/viewers
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video codec updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream latency updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
BasicAuth
| value |
Array of objects (StreamOutputVariant)
|
200
Stream Output Variants updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
RTMP port updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video Serving Endpoint updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
BasicAuth
| value |
object (S3Info)
|
200
Directory Enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
BasicAuth
200
Video playback metrics
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
Content type application/json
Copy Expand all Collapse all
`{
"errors": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"qualityVariantChanges": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"highestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"lowestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maximumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minimumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maxPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"availableBitrates": [0 ],
"segmentLength": 0,
"representation": 0
}`
204
No Content
options/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
Notification API
BasicAuth
| value |
object (DiscordNotificationConfiguration)
|
200
Discord notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
BasicAuth
| value |
object (BrowserNotificationConfiguration)
|
200
Browser notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
BasicAuth
200
All webhooks
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}
]`
204
No Content
options/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
BasicAuth
| id |
integer
|
200
Webhook successfully deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
Content type application/json
Copy
`{ "id": 0
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
BasicAuth
| url |
string
| | events |
Array of strings (WebhookEventType)
Items Enum: "CHAT" "USER_JOINED" "USER_PARTED" "NAME_CHANGE" "VISIBILITY-UPDATE" "PING" "PONG" "STREAM_STARTED" "STREAM_STOPPED" "STREAM_TITLE_UPDATED" "SYSTEM" "CHAT_ACTION"
|
200
The new webhook
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
Content type application/json
Copy Expand all Collapse all
`{
"url": "string",
"events": ["CHAT" ]
}`
Content type application/json
Copy Expand all Collapse all
`{
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}`
204
No Content
options/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
Social API
| account |
string
|
200
Contains redirect URL remote follow follow
400
Bad request
post/remotefollow
Localhost port 8080
http://localhost:8080/api/remotefollow
Content type application/json
Copy
`{ "account": "string"
}`
Content type application/json
Copy
`{ "redirectUrl": "string"
}`
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
Paginated follower count
400
Bad request
get/followers
Localhost port 8080
http://localhost:8080/api/followers
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": [ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}`
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
Paginated follower count
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": [ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}`
BasicAuth
200
List of pending followers
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
BasicAuth
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
BasicAuth
| actorIRI |
string
| | approved |
boolean
|
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
Content type application/json
Copy
`{
"actorIRI": "string",
"approved": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation features enabled/disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Private status set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation engagement set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation blocked domains set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Message sent
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
A paginated list of federated activities
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": {
"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}`
204
No Content
options/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
BasicAuth
200
Gives the status of the system
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/status
Localhost port 8080
http://localhost:8080/api/admin/status
Content type application/json
Copy Expand all Collapse all
`{
"broadcaster": {
"time": "2019-08-24T14:15:22Z",
"remoteAddr": "string",
"streamDetails": {
"videoCodec": "string",
"audioCodec": "string",
"encoder": "string",
"width": 0,
"height": 0,
"videoBitrate": 0,
"audioBitrate": 0,
"framerate": 0.1
}
},
"currentBroadcast": {
"outputSettings": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
],
"latencyLevel": { "level": 0
}
},
"health": {
"message": "string",
"healthPercentage": 0,
"representation": 0,
"healthy": true
},
"streamTitle": "string",
"versionNumber": "string",
"viewerCount": 0,
"overallPeakViewerCount": 0,
"sessionPeakViewerCount": 0,
"online": true
}`
BasicAuth
200
Contains information about disconnection status
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/disconnect
Localhost port 8080
http://localhost:8080/api/admin/disconnect
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
Current server config
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/serverconfig
Localhost port 8080
http://localhost:8080/api/admin/serverconfig
Content type application/json
Copy Expand all Collapse all
`{
"instanceDetails": {
"appearanceVariables": {
"property1": "string",
"property2": "string"
},
"version": "string",
"welcomeMessage": "string",
"offlineMessage": "string",
"logo": "string",
"name": "string",
"extraPageContent": "string",
"streamTitle": "string",
"customStyles": "string",
"customJavascript": "string",
"summary": "string",
"tags": ["string" ],
"socialHandles": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
],
"nsfw": true
},
"notifications": {
"browser": {
"goLiveMessage": "string",
"enabled": true
},
"discord": {
"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
},
"yp": {
"instanceUrl": "string",
"enabled": true
},
"ffmpegPath": "string",
"adminPassword": "string",
"socketHostOverride": "string",
"webServerIP": "string",
"videoCodec": "string",
"videoServingEndpoint": "string",
"s3": {
"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
},
"federation": {
"username": "string",
"goLiveMessage": "string",
"blockedDomains": ["string" ],
"enabled": true,
"isPrivate": true,
"showEngagement": true
},
"supportedCodecs": ["string" ],
"externalActions": [ {
"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
],
"forbiddenUsernames": ["string" ],
"suggestedUsernames": ["string" ],
"streamKeys": [ {
"key": "string",
"comment": "string"
}
],
"videoSettings": {
"videoQualityVariants": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
],
"latencyLevel": 0
},
"rtmpServerPort": 0,
"webServerPort": 0,
"chatDisabled": true,
"chatJoinMessagesEnabled": true,
"chatEstablishedUserMode": true,
"disableSearchIndexing": true,
"streamKeyOverridden": true,
"hideViewerCount": true
}`
BasicAuth
| windowStart |
string
Start date in unix time
|
200
Viewer count over time
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/viewersOverTime
Localhost port 8080
http://localhost:8080/api/admin/viewersOverTime
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]`
BasicAuth
200
List of active viewers
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/viewers
Localhost port 8080
http://localhost:8080/api/admin/viewers
Content type application/json
Copy Expand all Collapse all
`[ {
"firstSeen": "2019-08-24T14:15:22Z",
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"ipAddress": "string",
"clientID": "string"
}
]`
BasicAuth
200
Current hardware stats
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/hardwarestats
Localhost port 8080
http://localhost:8080/api/admin/hardwarestats
Content type application/json
Copy Expand all Collapse all
`{
"message": "string",
"healthPercentage": 0,
"representation": 0,
"healthy": true,
"disk": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"memory": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"cpu": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]
}`
BasicAuth
200
List of chat clients
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/clients
Localhost port 8080
http://localhost:8080/api/admin/chat/clients
Content type application/json
Copy Expand all Collapse all
`[ {
"connectedAt": "2019-08-24T14:15:22Z",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"geo": {
"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"messageCount": 0
}
]`
BasicAuth
200
List of chat messages for the admin
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/messages
Localhost port 8080
http://localhost:8080/api/admin/chat/messages
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "string",
"type": "string",
"id": "string",
"user": {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
},
"hiddenAt": "string",
"clientId": 0,
"body": "string"
}
]`
BasicAuth
| idArray |
Array of strings
| | visible |
boolean
|
200
Messages updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/admin/chat/messagevisibility
Content type application/json
Copy Expand all Collapse all
`{
"idArray": ["string" ],
"visible": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| userId |
string
| | enabled |
boolean
|
200
Successfully updated the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setenabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setenabled
Content type application/json
Copy
`{
"userId": "string",
"enabled": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of disabled users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/disabled
Localhost port 8080
http://localhost:8080/api/admin/chat/users/disabled
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
IP was successfully banned
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/create
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/create
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
| value |
string or boolean or Array of strings or number
|
200
IP ban was successfully removed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/ipbans/remove
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans/remove
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of banned IP addresses
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/ipbans
Localhost port 8080
http://localhost:8080/api/admin/chat/users/ipbans
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]`
BasicAuth
| userId |
string
| | isModerator |
boolean
|
200
Successfully update the moderator status of the user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/chat/users/setmoderator
Localhost port 8080
http://localhost:8080/api/admin/chat/users/setmoderator
Content type application/json
Copy
`{
"userId": "string",
"isModerator": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
List of moderator users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string" ],
"scopes": ["string" ],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]`
204
No Content
options/admin/chat/users/moderators
Localhost port 8080
http://localhost:8080/api/admin/chat/users/moderators
BasicAuth
200
List of logs
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/logs
Localhost port 8080
http://localhost:8080/api/admin/logs
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]`
204
No Content
options/admin/logs
Localhost port 8080
http://localhost:8080/api/admin/logs
BasicAuth
200
List of warnings and errors
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/logs/warnings
Localhost port 8080
http://localhost:8080/api/admin/logs/warnings
Content type application/json
Copy Expand all Collapse all
`[ {
"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]`
204
No Content
options/admin/logs/warnings
Localhost port 8080
http://localhost:8080/api/admin/logs/warnings
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
Paginated follower count
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": [ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}`
204
No Content
options/admin/followers
Localhost port 8080
http://localhost:8080/api/admin/followers
BasicAuth
200
List of pending followers
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/pending
Localhost port 8080
http://localhost:8080/api/admin/followers/pending
BasicAuth
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
Content type application/json
Copy Expand all Collapse all
`[ {
"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]`
204
No Content
options/admin/followers/blocked
Localhost port 8080
http://localhost:8080/api/admin/followers/blocked
BasicAuth
| actorIRI |
string
| | approved |
boolean
|
200
List of rejected or blocked follows
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
Content type application/json
Copy
`{
"actorIRI": "string",
"approved": true
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/followers/approve
Localhost port 8080
http://localhost:8080/api/admin/followers/approve
BasicAuth
| name |
string
| | data |
string
Base 64 encoded image data
|
200
Emoji has been uploaded
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
Content type application/json
Copy
`{
"name": "string",
"data": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/upload
Localhost port 8080
http://localhost:8080/api/admin/emoji/upload
BasicAuth
| name |
string
|
200
Emoji has been deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
Content type application/json
Copy
`{ "name": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/emoji/delete
Localhost port 8080
http://localhost:8080/api/admin/emoji/delete
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Admin password has been updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/adminpass
Localhost port 8080
http://localhost:8080/api/admin/config/adminpass
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/adminpass
Localhost port 8080
http://localhost:8080/api/admin/config/adminpass
BasicAuth
| value |
Array of objects (StreamKey)
|
200
Stream keys have been updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/streamkeys
Localhost port 8080
http://localhost:8080/api/admin/config/streamkeys
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"key": "string",
"comment": "string"
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/streamkeys
Localhost port 8080
http://localhost:8080/api/admin/config/streamkeys
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Page content has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/pagecontent
Localhost port 8080
http://localhost:8080/api/admin/config/pagecontent
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/pagecontent
Localhost port 8080
http://localhost:8080/api/admin/config/pagecontent
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream title has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/streamtitle
Localhost port 8080
http://localhost:8080/api/admin/config/streamtitle
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/streamtitle
Localhost port 8080
http://localhost:8080/api/admin/config/streamtitle
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server name has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/name
Localhost port 8080
http://localhost:8080/api/admin/config/name
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server summary has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/serversummary
Localhost port 8080
http://localhost:8080/api/admin/config/serversummary
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Offline message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/offlinemessage
Localhost port 8080
http://localhost:8080/api/admin/config/offlinemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Welcome message has been changed
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/welcomemessage
Localhost port 8080
http://localhost:8080/api/admin/config/welcomemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat has been disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/disable
Localhost port 8080
http://localhost:8080/api/admin/config/chat/disable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
User join messages has been enabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/joinmessagesenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/joinmessagesenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Chat established user mode updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/establishedusermode
Localhost port 8080
http://localhost:8080/api/admin/config/chat/establishedusermode
BasicAuth
| value |
Array of strings
|
200
Forbidden usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/forbiddenusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/forbiddenusernames
BasicAuth
| value |
Array of strings
|
200
Suggested usernames updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
Content type application/json
Copy Expand all Collapse all
`{ "value": ["string" ]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/suggestedusernames
Localhost port 8080
http://localhost:8080/api/admin/config/chat/suggestedusernames
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Spam protection enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/spamprotectionenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/spamprotectionenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Slur filter enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/slurfilterenabled
Localhost port 8080
http://localhost:8080/api/admin/config/chat/slurfilterenabled
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Require authentication setting updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/chat/requireauthentication
Localhost port 8080
http://localhost:8080/api/admin/config/chat/requireauthentication
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video codec updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/codec
Localhost port 8080
http://localhost:8080/api/admin/config/video/codec
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Stream latency updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamlatencylevel
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamlatencylevel
BasicAuth
| value |
Array of objects (StreamOutputVariant)
|
200
Stream Output Variants updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/video/streamoutputvariants
Localhost port 8080
http://localhost:8080/api/admin/config/video/streamoutputvariants
BasicAuth
| value |
object
|
200
Appearance updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/appearance
Localhost port 8080
http://localhost:8080/api/admin/config/appearance
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"property1": "string",
"property2": "string"
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/appearance
Localhost port 8080
http://localhost:8080/api/admin/config/appearance
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Logo updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/logo
Localhost port 8080
http://localhost:8080/api/admin/config/logo
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/logo
Localhost port 8080
http://localhost:8080/api/admin/config/logo
BasicAuth
| favicon |
string <binary>
Favicon file (PNG or ICO, max 200KB)
|
200
Favicon updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
BasicAuth
200
Favicon reset to default
401
Basic auth failure
default
Unexpected error
delete/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/favicon
Localhost port 8080
http://localhost:8080/api/admin/config/favicon
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Tags updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/tags
Localhost port 8080
http://localhost:8080/api/admin/config/tags
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/tags
Localhost port 8080
http://localhost:8080/api/admin/config/tags
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Path updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/ffmpegpath
Localhost port 8080
http://localhost:8080/api/admin/config/ffmpegpath
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/ffmpegpath
Localhost port 8080
http://localhost:8080/api/admin/config/ffmpegpath
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Port updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/webserverport
Localhost port 8080
http://localhost:8080/api/admin/config/webserverport
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/webserverport
Localhost port 8080
http://localhost:8080/api/admin/config/webserverport
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
IP Address updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/webserverip
Localhost port 8080
http://localhost:8080/api/admin/config/webserverip
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/webserverip
Localhost port 8080
http://localhost:8080/api/admin/config/webserverip
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
RTMP port updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/rtmpserverport
Localhost port 8080
http://localhost:8080/api/admin/config/rtmpserverport
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Websocket host override updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/sockethostoverride
Localhost port 8080
http://localhost:8080/api/admin/config/sockethostoverride
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Video Serving Endpoint updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/videoservingendpoint
Localhost port 8080
http://localhost:8080/api/admin/config/videoservingendpoint
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
NSFW status updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/nsfw
Localhost port 8080
http://localhost:8080/api/admin/config/nsfw
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/nsfw
Localhost port 8080
http://localhost:8080/api/admin/config/nsfw
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Directory Enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/directoryenabled
Localhost port 8080
http://localhost:8080/api/admin/config/directoryenabled
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/directoryenabled
Localhost port 8080
http://localhost:8080/api/admin/config/directoryenabled
BasicAuth
| value |
Array of objects (SocialHandle)
|
200
Social handles updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/socialhandles
Localhost port 8080
http://localhost:8080/api/admin/config/socialhandles
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"platform": "string",
"url": "string",
"icon": "string"
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/socialhandles
Localhost port 8080
http://localhost:8080/api/admin/config/socialhandles
BasicAuth
| value |
object (S3Info)
|
200
Directory Enabled updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/s3
Localhost port 8080
http://localhost:8080/api/admin/config/s3
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Server URL updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/serverurl
Localhost port 8080
http://localhost:8080/api/admin/config/serverurl
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/serverurl
Localhost port 8080
http://localhost:8080/api/admin/config/serverurl
BasicAuth
| value |
Array of objects (ExternalAction)
|
200
External Action Links updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/externalactions
Localhost port 8080
http://localhost:8080/api/admin/config/externalactions
Content type application/json
Copy Expand all Collapse all
`{ "value": [ {
"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
]
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/externalactions
Localhost port 8080
http://localhost:8080/api/admin/config/externalactions
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Custom styles updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/customstyles
Localhost port 8080
http://localhost:8080/api/admin/config/customstyles
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/customstyles
Localhost port 8080
http://localhost:8080/api/admin/config/customstyles
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Custom JavaScript updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/customjavascript
Localhost port 8080
http://localhost:8080/api/admin/config/customjavascript
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/customjavascript
Localhost port 8080
http://localhost:8080/api/admin/config/customjavascript
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Hide viewer count updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/hideviewercount
Localhost port 8080
http://localhost:8080/api/admin/config/hideviewercount
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/hideviewercount
Localhost port 8080
http://localhost:8080/api/admin/config/hideviewercount
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Search Indexing updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/disablesearchindexing
Localhost port 8080
http://localhost:8080/api/admin/config/disablesearchindexing
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/disablesearchindexing
Localhost port 8080
http://localhost:8080/api/admin/config/disablesearchindexing
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation features enabled/disabled
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/enable
Localhost port 8080
http://localhost:8080/api/admin/config/federation/enable
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Private status set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/private
Localhost port 8080
http://localhost:8080/api/admin/config/federation/private
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation engagement set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/showengagement
Localhost port 8080
http://localhost:8080/api/admin/config/federation/showengagement
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/username
Localhost port 8080
http://localhost:8080/api/admin/config/federation/username
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation username set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/livemessage
Localhost port 8080
http://localhost:8080/api/admin/config/federation/livemessage
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Federation blocked domains set
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/federation/blockdomains
Localhost port 8080
http://localhost:8080/api/admin/config/federation/blockdomains
BasicAuth
| value |
object (DiscordNotificationConfiguration)
|
200
Discord notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/discord
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/discord
BasicAuth
| value |
object (BrowserNotificationConfiguration)
|
200
Browser notification configuration updated
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
Content type application/json
Copy Expand all Collapse all
`{ "value": {
"goLiveMessage": "string",
"enabled": true
}
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/config/notifications/browser
Localhost port 8080
http://localhost:8080/api/admin/config/notifications/browser
BasicAuth
200
All webhooks
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
Content type application/json
Copy Expand all Collapse all
`[ {
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}
]`
204
No Content
options/admin/webhooks
Localhost port 8080
http://localhost:8080/api/admin/webhooks
BasicAuth
| id |
integer
|
200
Webhook successfully deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
Content type application/json
Copy
`{ "id": 0
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/webhooks/delete
Localhost port 8080
http://localhost:8080/api/admin/webhooks/delete
BasicAuth
| url |
string
| | events |
Array of strings (WebhookEventType)
Items Enum: "CHAT" "USER_JOINED" "USER_PARTED" "NAME_CHANGE" "VISIBILITY-UPDATE" "PING" "PONG" "STREAM_STARTED" "STREAM_STOPPED" "STREAM_TITLE_UPDATED" "SYSTEM" "CHAT_ACTION"
|
200
The new webhook
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
Content type application/json
Copy Expand all Collapse all
`{
"url": "string",
"events": ["CHAT" ]
}`
Content type application/json
Copy Expand all Collapse all
`{
"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT" ],
"id": 0
}`
204
No Content
options/admin/webhooks/create
Localhost port 8080
http://localhost:8080/api/admin/webhooks/create
BasicAuth
200
List of external API users
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/accesstokens
Localhost port 8080
http://localhost:8080/api/admin/accesstokens
Content type application/json
Copy Expand all Collapse all
`[ {
"createdAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"id": "string",
"accessToken": "string",
"displayName": "string",
"type": "string",
"scopes": ["string" ],
"displayColor": 0,
"isBot": true
}
]`
204
No Content
options/admin/accesstokens
Localhost port 8080
http://localhost:8080/api/admin/accesstokens
BasicAuth
| token |
string
|
200
External API user successfully deleted
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/accesstokens/delete
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/delete
Content type application/json
Copy
`{ "token": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/accesstokens/delete
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/delete
BasicAuth
| name |
string
| | scopes |
Array of strings
|
200
The new external API user
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/accesstokens/create
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/create
Content type application/json
Copy Expand all Collapse all
`{
"name": "string",
"scopes": ["string" ]
}`
Content type application/json
Copy Expand all Collapse all
`{
"createdAt": "2019-08-24T14:15:22Z",
"lastUsedAt": "2019-08-24T14:15:22Z",
"id": "string",
"accessToken": "string",
"displayName": "string",
"type": "string",
"scopes": ["string" ],
"displayColor": 0,
"isBot": true
}`
204
No Content
options/admin/accesstokens/create
Localhost port 8080
http://localhost:8080/api/admin/accesstokens/create
BasicAuth
200
Current auto-update options
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/options
Localhost port 8080
http://localhost:8080/api/admin/update/options
Content type application/json
Copy
`{
"supportsUpdate": true,
"canRestart": true
}`
204
No Content
options/admin/update/options
Localhost port 8080
http://localhost:8080/api/admin/update/options
BasicAuth
200
Console output from update
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/start
Localhost port 8080
http://localhost:8080/api/admin/update/start
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/update/start
Localhost port 8080
http://localhost:8080/api/admin/update/start
BasicAuth
200
Server force restart has been ordered
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/update/forcequit
Localhost port 8080
http://localhost:8080/api/admin/update/forcequit
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/update/forcequit
Localhost port 8080
http://localhost:8080/api/admin/update/forcequit
BasicAuth
200
YP Registration has been reset
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/yp/reset
Localhost port 8080
http://localhost:8080/api/admin/yp/reset
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/yp/reset
Localhost port 8080
http://localhost:8080/api/admin/yp/reset
BasicAuth
200
Video playback metrics
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
Content type application/json
Copy Expand all Collapse all
`{
"errors": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"qualityVariantChanges": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"highestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"lowestLatency": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maximumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minimumSegmentDownloadDuration": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"minPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"medianPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"maxPlayerBitrate": [ {
"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
],
"availableBitrates": [0 ],
"segmentLength": 0,
"representation": 0
}`
204
No Content
options/admin/metrics/video
Localhost port 8080
http://localhost:8080/api/admin/metrics/video
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
get/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
post/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
put/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
delete/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
This endpoint interfaces with the Prometheus metrics API.
Learn more about it on the Prometheus API docs
options/admin/prometheus
Localhost port 8080
http://localhost:8080/api/admin/prometheus
BasicAuth
A single value that is used in the request
| value |
string or boolean or Array of strings or number
|
200
Message sent
400
Bad request
401
Basic auth failure
default
Unexpected error
post/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
Content type application/json
Copy
`{ "value": "string"
}`
Content type application/json
Copy
`{
"message": "string",
"success": true
}`
204
No Content
options/admin/federation/send
Localhost port 8080
http://localhost:8080/api/admin/federation/send
BasicAuth
| offset |
integer
The number of items to skip before starting to collect the result set
| | limit |
integer
The numbers of items to return
|
200
A paginated list of federated activities
400
Bad request
401
Basic auth failure
default
Unexpected error
get/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
Content type application/json
Copy Expand all Collapse all
`{
"total": 0,
"results": {
"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}`
204
No Content
options/admin/federation/actions
Localhost port 8080
http://localhost:8080/api/admin/federation/actions
204
No Content
options/integrations/chat/system
Localhost port 8080
http://localhost:8080/api/integrations/chat/system
| clientId required |
integer
The ID of the specified client
|
204
No Content
options/integrations/chat/system/client/{clientId}
Localhost port 8080
http://localhost:8080/api/integrations/chat/system/client/{clientId}
204
No Content
options/integrations/chat/user
Localhost port 8080
http://localhost:8080/api/integrations/chat/user
204
No Content
options/integrations/chat/send
Localhost port 8080
http://localhost:8080/api/integrations/chat/send
204
No Content
options/integrations/chat/action
Localhost port 8080
http://localhost:8080/api/integrations/chat/action
204
No Content
options/integrations/chat/messagevisibility
Localhost port 8080
http://localhost:8080/api/integrations/chat/messagevisibility
204
No Content
options/integrations/streamtitle
Localhost port 8080
http://localhost:8080/api/integrations/streamtitle
204
No Content
options/integrations/chat
Localhost port 8080
http://localhost:8080/api/integrations/chat
204
No Content
options/integrations/clients
Localhost port 8080