Owncast APIs (0.2.0)

Download OpenAPI specification:Download

Gabe Kangas: gabek@real-ity.com 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.

External

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.

Send a system message to the chat

Authorizations:

BearerAuth

Request Body schema: application/json

The content of the system message

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

Send a system message to a single client

Authorizations:

BearerAuth

path Parameters

clientId

required

integer

The ID of the specified client

Request Body schema: application/json

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

400
500
default

Content type

application/json

{"message": "string",
"success": true
}

Send a user message to chat Deprecated

Authorizations:

BearerAuth

Responses

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:

BearerAuth

Request Body schema: application/json

timestamp	string
type	string
id	string
	object (User)
hiddenAt	string
clientId	integer
body	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

SendIntegrationChatMessageOptions

Responses

Send a user action to chat

Authorizations:

BearerAuth

Request Body schema: application/json

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

Hide chat message

Authorizations:

BearerAuth

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ExternalUpdateMessageVisibilityOptions

Responses

Stream title

Authorizations:

BearerAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ExternalSetStreamTitleOptions

Responses

Get chat history

Authorizations:

BearerAuth

Responses

Response samples

200
501
default

Content type

application/json

[{"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"
}
]

ExternalGetChatMessagesOptions

Responses

Connected clients

Authorizations:

BearerAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

ExternalGetConnectedChatClientsOptions

Responses

Get a user's details

path Parameters

userId

required

string

The ID of the user to find

query Parameters

accessToken

required

string

Responses

Response samples

200
default

Content type

application/json

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

Internal

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.

Get the status of the server

Responses

Response samples

200

Content type

application/json

{"serverTime": "string",
"lastConnectTime": "string",
"lastDisconnectTime": "string",
"versionNumber": "string",
"viewerCount": 0,
"online": true,
"streamTitle": "string"
}

Get list of custom emojis supported in the chat

Responses

Response samples

200
500

Content type

application/json

[{"name": "string",
"url": "string"
}
]

Gets a list of chat messages

query Parameters

accessToken

required

string

Responses

Response samples

200
501

Content type

application/json

[{"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"
}
]

Registers an anonymous chat user

header Parameters

X-Forwarded-User

string

Request Body schema: application/json
optional

The display name of the new user

displayName

string

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string"
}

Response samples

200
400

Content type

application/json

{"id": "string",
"accessToken": "string",
"displayName": "string"
}

Update chat message visibility

query Parameters

accessToken

required

string

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Enable/disable a user

query Parameters

accessToken

required

string

Request Body schema: application/json

userId	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"enabled": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get the web config

Responses

Response samples

200
500

Content type

application/json

{"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,
"nsfw": true,
"authentication": {"indieAuthEnabled": true
}
}

Get the YP protocol data

Responses

Response samples

200

Content type

application/json

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

Get all social platforms

Responses

Response samples

200
500

Content type

application/json

{"property1": {"platform": "string",
"url": "string",
"icon": "string"
},
"property2": {"platform": "string",
"url": "string",
"icon": "string"
}
}

Get a list of video variants available

Responses

Response samples

200

Content type

application/json

[{"index": 0,
"name": "string"
}
]

Tell the backend you're an active viewer

Responses

Request remote follow

Request Body schema: application/json

account

string

Responses

Request samples

Payload

Content type

application/json

{"account": "string"
}

Response samples

200
400

Content type

application/json

{"redirectUrl": "string"
}

Gets the list of followers

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400

Content type

application/json

{"total": 0,
"results": [{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}

Save video playback metrics for future video health recording

Request Body schema: application/json

Video metrics to record

bandwidth	number <double>
latency	number <double>
errors	number <double>
downloadDuration	number <double>
qualityVariantChanges	number <double>

Responses

Request samples

Payload

Content type

application/json

{"bandwidth": 0.1,
"latency": 0.1,
"errors": 0.1,
"downloadDuration": 0.1,
"qualityVariantChanges": 0.1
}

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Register for notifications

query Parameters

accessToken

required

string

Request Body schema: application/json

Information for notification

channel	string Name of notification channel
destination	string Target of the notification in the channel

Responses

Request samples

Payload

Content type

application/json

{"channel": "string",
"destination": "string"
}

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Get current inboard broadcaster

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Disconnect inbound stream

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get the current server config

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Get viewer count over time

Authorizations:

BasicAuth

query Parameters

windowStart

string

Start date in unix time

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]

Get active viewers

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"firstSeen": "2019-08-24T14:15:22Z",
"geo": {"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"ipAddress": "string",
"clientID": "string"
}
]

Get the current hardware stats

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Get a detailed list of currently connected chat clients

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

Get all chat messages for the admin, unfiltered

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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"
}
]

Update visibility of chat messages

Authorizations:

BasicAuth

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Enable or disable a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"enabled": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get a list of disabled users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

Ban an IP address

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Remove an IP ban

Authorizations:

BasicAuth

Request Body schema: application/json

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get all banned IP addresses

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]

Set moderator status for a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
isModerator	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"isModerator": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get a list of moderator users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

GetModeratorsOptions

Responses

Get all logs

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]

GetLogsOptions

Responses

Get warning/error logs

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]

GetWarningsOptions

Responses

Get followers

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": [{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}

GetFollowersAdminOptions

Responses

Get a list of pending follow requests

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetPendingFollowRequestsOptions

Responses

Get a list of rejected or blocked follows

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetBlockedAndRejectedFollowersOptions

Responses

Set the following state of a follower or follow request

Authorizations:

BasicAuth

Request Body schema: application/json

actorIRI	string
approved	boolean

Responses

Request samples

Payload

Content type

application/json

{"actorIRI": "string",
"approved": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ApproveFollowerOptions

Responses

Upload custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
data	string Base 64 encoded image data

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"data": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UploadCustomEmojiOptions

Responses

Delete custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteCustomEmojiOptions

Responses

Change the current admin password

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetAdminPasswordOptions

Responses

Set an array of valid stream keys

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (StreamKey)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"key": "string",
"comment": "string"
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamKeysOptions

Responses

Change the extra page content in memory

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetExtraPageContentOptions

Responses

Change the stream title

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamTitleOptions

Responses

Change the server name

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerNameOptions

Responses

Change the server summary

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerSummaryOptions

Responses

Change the offline message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomOfflineMessageOptions

Responses

Change the welcome message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerWelcomeMessageOptions

Responses

Disable chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatDisabledOptions

Responses

Enable chat for user join messages

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatJoinMessagesEnabledOptions

Responses

Enable/disable chat established user mode

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetEnableEstablishedChatUserModeOptions

Responses

Set chat usernames that are not allowed

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetForbiddenUsernameListOptions

Responses

Set the suggested chat usernames that will be assigned automatically

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSuggestedUsernameListOptions

Responses

Set spam protection enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSpamProtectionEnabledOptions

Responses

Set slur filter enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSlurFilterEnabledOptions

Responses

Set video codec

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoCodecOptions

Responses

Set the number of video segments and duration per segment in a playlist

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamLatencyLevelOptions

Responses

Set an array of video output configurations

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (StreamOutputVariant)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamOutputVariantsOptions

Responses

Set style/color/css values

Authorizations:

BasicAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"value": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomColorVariableValuesOptions

Responses

Update logo

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetLogoOptions

Responses

Update server tags

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetTagsOptions

Responses

Update FFMPEG path

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFfmpegPathOptions

Responses

Update server port

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetWebServerPortOptions

Responses

Update server IP address

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetWebServerIPOptions

Responses

Update RTMP post

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetRTMPServerPortOptions

Responses

Update websocket host override

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSocketHostOverrideOptions

Responses

Update custom video serving endpoint

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoServingEndpointOptions

Responses

Update NSFW marking

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetNSFWOptions

Responses

Update directory enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDirectoryEnabledOptions

Responses

Update social handles

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (SocialHandle)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"platform": "string",
"url": "string",
"icon": "string"
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSocialHandlesOptions

Responses

Update S3 configuration

Authorizations:

BasicAuth

Request Body schema: application/json

object (S3Info)

Responses

Request samples

Payload

Content type

application/json

{"value": {"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetS3ConfigurationOptions

Responses

Update server url

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerURLOptions

Responses

Update external action links

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (ExternalAction)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetExternalActionsOptions

Responses

Update custom styles

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomStylesOptions

Responses

Update custom JavaScript

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomJavascriptOptions

Responses

Update hide viewer count

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetHideViewerCountOptions

Responses

Update search indexing

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDisableSearchIndexingOptions

Responses

Enable/disable federation features

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationEnabledOptions

Responses

Set if federation activities are private

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationActivityPrivateOptions

Responses

Set if fediverse engagement appears in chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationShowEngagementOptions

Responses

Set local federated username

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationUsernameOptions

Responses

Set federated go live message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationGoLiveMessageOptions

Responses

Set Federation blocked domains

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationBlockDomainsOptions

Responses

Configure Discord notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (DiscordNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDiscordNotificationConfigurationOptions

Responses

Configure Browser notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (BrowserNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetBrowserNotificationConfigurationOptions

Responses

Get all the webhooks

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}
]

GetWebhooksOptions

Responses

Delete a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

id

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteWebhookOptions

Responses

Create a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

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"

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"events": ["CHAT"
]
}

Response samples

200
400
default

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}

CreateWebhookOptions

Responses

Get all access tokens

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

GetExternalAPIUsersOptions

Responses

Delete a single external API user

Authorizations:

BasicAuth

Request Body schema: application/json

token

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteExternalAPIUserOptions

Responses

Create a single access token

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
scopes	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"scopes": ["string"
]
}

Response samples

200
400
default

Content type

application/json

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

CreateExternalAPIUserOptions

Responses

Return the auto-update features that are supported for this instance

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"supportsUpdate": true,
"canRestart": true
}

AutoUpdateOptionsOptions

Responses

Begin the auto-update

Authorizations:

BasicAuth

Responses

Response samples

400
default

Content type

application/json

{"message": "string",
"success": true
}

AutoUpdateStartOptions

Responses

Force quit the server and restart it

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

AutoUpdateForceQuitOptions

Responses

Reset YP configuration

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ResetYPRegistrationOptions

Responses

Get video playback metrics

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

GetVideoPlaybackMetricsOptions

Responses

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Send a public message to the Fediverse from the server's user

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SendFederatedMessageOptions

Responses

Get a paginated list of federated activities

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": {"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}

GetFederatedActionsOptions

Responses

SendSystemMessageOptions

Responses

SendSystemMessageToConnectedClientOptions

path Parameters

clientId

required

integer

The ID of the specified client

Responses

SendUserMessageOptions Deprecated

Responses

SendChatActionOptions

Responses

Begins auth flow

query Parameters

accessToken

required

string

Request Body schema: application/json

authHost

string

Responses

Request samples

Payload

Content type

application/json

{"authHost": "string"
}

Response samples

200
400
default

Content type

application/json

{"redirect": "string"
}

Handle the redirect from an IndieAuth server to continue the auth flow

query Parameters

state required	string
code required	string

Responses

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Handles the IndieAuth auth endpoint

Authorizations:

BasicAuth

query Parameters

client_id required	string
redirect_uri required	string
code_challenge required	string
state required	string
code required	string

Responses

Response samples

200
400
500

Content type

application/json

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Handles IndieAuth from form submission

Request Body schema: application/x-www-form-urlencoded

Form submission from IndieAuth

code	string
redirect_uri	string
client_id	string
codeVerifier	string

Responses

Response samples

200
400

Content type

application/json

Example

IndieAuthResponse

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Register a Fediverse OTP request

query Parameters

accessToken

required

string

Request Body schema: application/json

account

string

Responses

Request samples

Payload

Content type

application/json

{"account": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Verify Fediverse OTP code

Request Body schema: application/json

code

string

Responses

Request samples

Payload

Content type

application/json

{"code": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Auth

Authentication API

Begins auth flow

query Parameters

accessToken

required

string

Request Body schema: application/json

authHost

string

Responses

Request samples

Payload

Content type

application/json

{"authHost": "string"
}

Response samples

200
400
default

Content type

application/json

{"redirect": "string"
}

Handle the redirect from an IndieAuth server to continue the auth flow

query Parameters

state required	string
code required	string

Responses

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Handles the IndieAuth auth endpoint

Authorizations:

BasicAuth

query Parameters

client_id required	string
redirect_uri required	string
code_challenge required	string
state required	string
code required	string

Responses

Response samples

200
400
500

Content type

application/json

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Handles IndieAuth from form submission

Request Body schema: application/x-www-form-urlencoded

Form submission from IndieAuth

code	string
redirect_uri	string
client_id	string
codeVerifier	string

Responses

Response samples

200
400

Content type

application/json

Example

IndieAuthResponse

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Register a Fediverse OTP request

query Parameters

accessToken

required

string

Request Body schema: application/json

account

string

Responses

Request samples

Payload

Content type

application/json

{"account": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Verify Fediverse OTP code

Request Body schema: application/json

code

string

Responses

Request samples

Payload

Content type

application/json

{"code": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Chat

APIs related to operating the chat system.

Get list of custom emojis supported in the chat

Responses

Response samples

200
500

Content type

application/json

[{"name": "string",
"url": "string"
}
]

Gets a list of chat messages

query Parameters

accessToken

required

string

Responses

Response samples

200
501

Content type

application/json

[{"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"
}
]

Registers an anonymous chat user

header Parameters

X-Forwarded-User

string

Request Body schema: application/json
optional

The display name of the new user

displayName

string

Responses

Request samples

Payload

Content type

application/json

{"displayName": "string"
}

Response samples

200
400

Content type

application/json

{"id": "string",
"accessToken": "string",
"displayName": "string"
}

RegisterAnonymousChatUserOptions

Responses

Update chat message visibility

query Parameters

accessToken

required

string

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Enable/disable a user

query Parameters

accessToken

required

string

Request Body schema: application/json

userId	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"enabled": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get a detailed list of currently connected chat clients

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

GetConnectedChatClientsOptions

Responses

Get all chat messages for the admin, unfiltered

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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"
}
]

GetChatMessagesAdminOptions

Responses

Update visibility of chat messages

Authorizations:

BasicAuth

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UpdateMessageVisibilityAdminOptions

Responses

Enable or disable a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"enabled": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UpdateUserEnabledAdminOptions

Responses

Get a list of disabled users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

GetDisabledUsersOptions

Responses

Ban an IP address

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

BanIPAddressOptions

Responses

Remove an IP ban

Authorizations:

BasicAuth

Request Body schema: application/json

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UnbanIPAddressOptions

Responses

Get all banned IP addresses

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]

GetIPAddressBansOptions

Responses

Set moderator status for a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
isModerator	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"isModerator": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UpdateUserModeratorOptions

Responses

Get a list of moderator users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

Upload custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
data	string Base 64 encoded image data

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"data": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UploadCustomEmojiOptions

Responses

Delete custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteCustomEmojiOptions

Responses

Change the welcome message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerWelcomeMessageOptions

Responses

Disable chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatDisabledOptions

Responses

Enable chat for user join messages

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatJoinMessagesEnabledOptions

Responses

Enable/disable chat established user mode

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetEnableEstablishedChatUserModeOptions

Responses

Set chat usernames that are not allowed

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetForbiddenUsernameListOptions

Responses

Set the suggested chat usernames that will be assigned automatically

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSuggestedUsernameListOptions

Responses

Set spam protection enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSpamProtectionEnabledOptions

Responses

Set slur filter enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSlurFilterEnabledOptions

Responses

Update websocket host override

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSocketHostOverrideOptions

Responses

Send a system message to the chat

Authorizations:

BearerAuth

Request Body schema: application/json

The content of the system message

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

SendSystemMessageOptions

Responses

Send a system message to a single client

Authorizations:

BearerAuth

path Parameters

clientId

required

integer

The ID of the specified client

Request Body schema: application/json

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

400
500
default

Content type

application/json

{"message": "string",
"success": true
}

SendSystemMessageToConnectedClientOptions

path Parameters

clientId

required

integer

The ID of the specified client

Responses

Send a user message to chat Deprecated

Authorizations:

BearerAuth

Responses

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

SendUserMessageOptions Deprecated

Responses

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:

BearerAuth

Request Body schema: application/json

timestamp	string
type	string
id	string
	object (User)
hiddenAt	string
clientId	integer
body	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

SendIntegrationChatMessageOptions

Responses

Send a user action to chat

Authorizations:

BearerAuth

Request Body schema: application/json

timestamp	string
type	string
id	string
body	string

Responses

Request samples

Payload

Content type

application/json

{"timestamp": "string",
"type": "string",
"id": "string",
"body": "string"
}

Response samples

200
400
500
default

Content type

application/json

{"message": "string",
"success": true
}

SendChatActionOptions

Responses

Hide chat message

Authorizations:

BearerAuth

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ExternalUpdateMessageVisibilityOptions

Responses

Get chat history

Authorizations:

BearerAuth

Responses

Response samples

200
501
default

Content type

application/json

[{"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"
}
]

ExternalGetChatMessagesOptions

Responses

Connected clients

Authorizations:

BearerAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

ExternalGetConnectedChatClientsOptions

Responses

Get a user's details

path Parameters

userId

required

string

The ID of the user to find

query Parameters

accessToken

required

string

Responses

Response samples

200
default

Content type

application/json

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

Begins auth flow

query Parameters

accessToken

required

string

Request Body schema: application/json

authHost

string

Responses

Request samples

Payload

Content type

application/json

{"authHost": "string"
}

Response samples

200
400
default

Content type

application/json

{"redirect": "string"
}

Handle the redirect from an IndieAuth server to continue the auth flow

query Parameters

state required	string
code required	string

Responses

Response samples

400

Content type

application/json

{"message": "string",
"success": true
}

Handles the IndieAuth auth endpoint

Authorizations:

BasicAuth

query Parameters

client_id required	string
redirect_uri required	string
code_challenge required	string
state required	string
code required	string

Responses

Response samples

200
400
500

Content type

application/json

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Handles IndieAuth from form submission

Request Body schema: application/x-www-form-urlencoded

Form submission from IndieAuth

code	string
redirect_uri	string
client_id	string
codeVerifier	string

Responses

Response samples

200
400

Content type

application/json

Example

IndieAuthResponse

{"me": "string",
"profile": {"name": "string",
"url": "string",
"photo": "string"
},
"error": "string",
"errorDescription": "string"
}

Register a Fediverse OTP request

query Parameters

accessToken

required

string

Request Body schema: application/json

account

string

Responses

Request samples

Payload

Content type

application/json

{"account": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Verify Fediverse OTP code

Request Body schema: application/json

code

string

Responses

Request samples

Payload

Content type

application/json

{"code": "string"
}

Response samples

200
400

Content type

application/json

{"message": "string",
"success": true
}

Objects

Object definitions

RegisterAnonymousChatUserOptions

Responses

StatusAdminOptions

Responses

DisconnectInboundConnectionOptions

Responses

GetServerConfigOptions

Responses

GetViewersOverTimeOptions

Responses

GetActiveViewersOptions

Responses

GetHardwareStatsOptions

Responses

GetConnectedChatClientsOptions

Responses

GetChatMessagesAdminOptions

Responses

UpdateMessageVisibilityAdminOptions

Responses

UpdateUserEnabledAdminOptions

Responses

GetDisabledUsersOptions

Responses

BanIPAddressOptions

Responses

UnbanIPAddressOptions

Responses

GetIPAddressBansOptions

Responses

UpdateUserModeratorOptions

Responses

GetModeratorsOptions

Responses

GetLogsOptions

Responses

GetWarningsOptions

Responses

GetFollowersAdminOptions

Responses

GetPendingFollowRequestsOptions

Responses

GetBlockedAndRejectedFollowersOptions

Responses

ApproveFollowerOptions

Responses

UploadCustomEmojiOptions

Responses

DeleteCustomEmojiOptions

Responses

SetAdminPasswordOptions

Responses

SetStreamKeysOptions

Responses

SetExtraPageContentOptions

Responses

SetStreamTitleOptions

Responses

Change the server name

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerNameOptions

Responses

Change the server summary

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerSummaryOptions

Responses

Change the offline message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomOfflineMessageOptions

Responses

SetServerWelcomeMessageOptions

Responses

SetChatDisabledOptions

Responses

SetChatJoinMessagesEnabledOptions

Responses

SetEnableEstablishedChatUserModeOptions

Responses

SetForbiddenUsernameListOptions

Responses

SetSuggestedUsernameListOptions

Responses

SetChatSpamProtectionEnabledOptions

Responses

SetChatSlurFilterEnabledOptions

Responses

SetVideoCodecOptions

Responses

SetStreamLatencyLevelOptions

Responses

SetStreamOutputVariantsOptions

Responses

SetCustomColorVariableValuesOptions

Responses

SetLogoOptions

Responses

SetTagsOptions

Responses

SetFfmpegPathOptions

Responses

SetWebServerPortOptions

Responses

SetWebServerIPOptions

Responses

SetRTMPServerPortOptions

Responses

SetSocketHostOverrideOptions

Responses

SetVideoServingEndpointOptions

Responses

SetNSFWOptions

Responses

SetDirectoryEnabledOptions

Responses

SetSocialHandlesOptions

Responses

SetS3ConfigurationOptions

Responses

SetServerURLOptions

Responses

SetExternalActionsOptions

Responses

SetCustomStylesOptions

Responses

SetCustomJavascriptOptions

Responses

SetHideViewerCountOptions

Responses

SetDisableSearchIndexingOptions

Responses

SetFederationEnabledOptions

Responses

SetFederationActivityPrivateOptions

Responses

SetFederationShowEngagementOptions

Responses

SetFederationUsernameOptions

Responses

SetFederationGoLiveMessageOptions

Responses

SetFederationBlockDomainsOptions

Responses

SetDiscordNotificationConfigurationOptions

Responses

SetBrowserNotificationConfigurationOptions

Responses

GetWebhooksOptions

Responses

DeleteWebhookOptions

Responses

CreateWebhookOptions

Responses

GetExternalAPIUsersOptions

Responses

DeleteExternalAPIUserOptions

Responses

CreateExternalAPIUserOptions

Responses

AutoUpdateOptionsOptions

Responses

AutoUpdateStartOptions

Responses

AutoUpdateForceQuitOptions

Responses

ResetYPRegistrationOptions

Responses

GetVideoPlaybackMetricsOptions

Responses

SendFederatedMessageOptions

Responses

GetFederatedActionsOptions

Responses

SendSystemMessageOptions

Responses

SendSystemMessageToConnectedClientOptions

path Parameters

clientId

required

integer

The ID of the specified client

Responses

SendUserMessageOptions Deprecated

Responses

SendIntegrationChatMessageOptions

Responses

SendChatActionOptions

Responses

ExternalUpdateMessageVisibilityOptions

Responses

ExternalSetStreamTitleOptions

Responses

ExternalGetChatMessagesOptions

Responses

ExternalGetConnectedChatClientsOptions

Responses

Video

Video API

Get a list of video variants available

Responses

Response samples

200

Content type

application/json

[{"index": 0,
"name": "string"
}
]

Tell the backend you're an active viewer

Responses

Disconnect inbound stream

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DisconnectInboundConnectionOptions

Responses

GetActiveViewersOptions

Responses

Set video codec

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoCodecOptions

Responses

Set the number of video segments and duration per segment in a playlist

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamLatencyLevelOptions

Responses

Set an array of video output configurations

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (StreamOutputVariant)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamOutputVariantsOptions

Responses

Update RTMP post

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetRTMPServerPortOptions

Responses

Update custom video serving endpoint

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoServingEndpointOptions

Responses

Update S3 configuration

Authorizations:

BasicAuth

Request Body schema: application/json

object (S3Info)

Responses

Request samples

Payload

Content type

application/json

{"value": {"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetS3ConfigurationOptions

Responses

Get video playback metrics

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

GetVideoPlaybackMetricsOptions

Responses

Notifications

Notification API

Configure Discord notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (DiscordNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDiscordNotificationConfigurationOptions

Responses

Configure Browser notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (BrowserNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetBrowserNotificationConfigurationOptions

Responses

Get all the webhooks

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}
]

GetWebhooksOptions

Responses

Delete a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

id

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteWebhookOptions

Responses

Create a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

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"

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"events": ["CHAT"
]
}

Response samples

200
400
default

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}

CreateWebhookOptions

Responses

Social

Social API

Request remote follow

Request Body schema: application/json

account

string

Responses

Request samples

Payload

Content type

application/json

{"account": "string"
}

Response samples

200
400

Content type

application/json

{"redirectUrl": "string"
}

Gets the list of followers

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400

Content type

application/json

{"total": 0,
"results": [{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}

Get followers

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": [{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}

Get a list of pending follow requests

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetPendingFollowRequestsOptions

Responses

Get a list of rejected or blocked follows

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetBlockedAndRejectedFollowersOptions

Responses

Set the following state of a follower or follow request

Authorizations:

BasicAuth

Request Body schema: application/json

actorIRI	string
approved	boolean

Responses

Request samples

Payload

Content type

application/json

{"actorIRI": "string",
"approved": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ApproveFollowerOptions

Responses

Enable/disable federation features

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationEnabledOptions

Responses

Set if federation activities are private

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationActivityPrivateOptions

Responses

Set if fediverse engagement appears in chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationShowEngagementOptions

Responses

Set local federated username

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationUsernameOptions

Responses

Set federated go live message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationGoLiveMessageOptions

Responses

Set Federation blocked domains

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationBlockDomainsOptions

Responses

Send a public message to the Fediverse from the server's user

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SendFederatedMessageOptions

Responses

Get a paginated list of federated activities

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": {"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}

GetFederatedActionsOptions

Responses

Admin

Get current inboard broadcaster

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Disconnect inbound stream

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get the current server config

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Get viewer count over time

Authorizations:

BasicAuth

query Parameters

windowStart

string

Start date in unix time

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"value": 0.1
}
]

Get active viewers

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"firstSeen": "2019-08-24T14:15:22Z",
"geo": {"countryCode": "string",
"regionName": "string",
"timeZone": "string"
},
"userAgent": "string",
"ipAddress": "string",
"clientID": "string"
}
]

Get the current hardware stats

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

Get a detailed list of currently connected chat clients

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

Get all chat messages for the admin, unfiltered

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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"
}
]

Update visibility of chat messages

Authorizations:

BasicAuth

Request Body schema: application/json

idArray	Array of strings
visible	boolean

Responses

Request samples

Payload

Content type

application/json

{"idArray": ["string"
],
"visible": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Enable or disable a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"enabled": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get a list of disabled users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

Ban an IP address

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Remove an IP ban

Authorizations:

BasicAuth

Request Body schema: application/json

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get all banned IP addresses

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "2019-08-24T14:15:22Z",
"ipAddress": "string",
"notes": "string"
}
]

Set moderator status for a user

Authorizations:

BasicAuth

Request Body schema: application/json

userId	string
isModerator	boolean

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"isModerator": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

Get a list of moderator users

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"createdAt": "string",
"disabledAt": "string",
"nameChangedAt": "string",
"id": "string",
"displayName": "string",
"previousNames": ["string"
],
"scopes": ["string"
],
"displayColor": 0,
"isBot": true,
"authenticated": true
}
]

GetModeratorsOptions

Responses

Get all logs

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]

GetLogsOptions

Responses

Get warning/error logs

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"time": "2019-08-24T14:15:22Z",
"message": "string",
"level": "string"
}
]

GetWarningsOptions

Responses

Get followers

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": [{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]
}

GetFollowersAdminOptions

Responses

Get a list of pending follow requests

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetPendingFollowRequestsOptions

Responses

Get a list of rejected or blocked follows

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"link": "string",
"name": "string",
"username": "string",
"image": "string",
"timestamp": "string",
"disabledAt": "string"
}
]

GetBlockedAndRejectedFollowersOptions

Responses

Set the following state of a follower or follow request

Authorizations:

BasicAuth

Request Body schema: application/json

actorIRI	string
approved	boolean

Responses

Request samples

Payload

Content type

application/json

{"actorIRI": "string",
"approved": true
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ApproveFollowerOptions

Responses

Upload custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
data	string Base 64 encoded image data

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"data": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

UploadCustomEmojiOptions

Responses

Delete custom emoji

Authorizations:

BasicAuth

Request Body schema: application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteCustomEmojiOptions

Responses

Change the current admin password

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetAdminPasswordOptions

Responses

Set an array of valid stream keys

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (StreamKey)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"key": "string",
"comment": "string"
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamKeysOptions

Responses

Change the extra page content in memory

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetExtraPageContentOptions

Responses

Change the stream title

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamTitleOptions

Responses

Change the server name

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerNameOptions

Responses

Change the server summary

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerSummaryOptions

Responses

Change the offline message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomOfflineMessageOptions

Responses

Change the welcome message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerWelcomeMessageOptions

Responses

Disable chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatDisabledOptions

Responses

Enable chat for user join messages

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatJoinMessagesEnabledOptions

Responses

Enable/disable chat established user mode

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetEnableEstablishedChatUserModeOptions

Responses

Set chat usernames that are not allowed

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetForbiddenUsernameListOptions

Responses

Set the suggested chat usernames that will be assigned automatically

Authorizations:

BasicAuth

Request Body schema: application/json

value

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"value": ["string"
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSuggestedUsernameListOptions

Responses

Set spam protection enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSpamProtectionEnabledOptions

Responses

Set slur filter enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetChatSlurFilterEnabledOptions

Responses

Set video codec

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoCodecOptions

Responses

Set the number of video segments and duration per segment in a playlist

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamLatencyLevelOptions

Responses

Set an array of video output configurations

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (StreamOutputVariant)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"name": "string",
"videoPassthrough": true,
"audioPassthrough": true,
"videoBitrate": 0,
"audioBitrate": 0,
"scaledWidth": 0,
"scaledHeight": 0,
"framerate": 0,
"cpuUsageLevel": 0
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetStreamOutputVariantsOptions

Responses

Set style/color/css values

Authorizations:

BasicAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"value": {"property1": "string",
"property2": "string"
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomColorVariableValuesOptions

Responses

Update logo

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetLogoOptions

Responses

Update server tags

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetTagsOptions

Responses

Update FFMPEG path

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFfmpegPathOptions

Responses

Update server port

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetWebServerPortOptions

Responses

Update server IP address

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetWebServerIPOptions

Responses

Update RTMP post

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetRTMPServerPortOptions

Responses

Update websocket host override

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSocketHostOverrideOptions

Responses

Update custom video serving endpoint

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetVideoServingEndpointOptions

Responses

Update NSFW marking

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetNSFWOptions

Responses

Update directory enabled

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDirectoryEnabledOptions

Responses

Update social handles

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (SocialHandle)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"platform": "string",
"url": "string",
"icon": "string"
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetSocialHandlesOptions

Responses

Update S3 configuration

Authorizations:

BasicAuth

Request Body schema: application/json

object (S3Info)

Responses

Request samples

Payload

Content type

application/json

{"value": {"endpoint": "string",
"accessKey": "string",
"secret": "string",
"bucket": "string",
"region": "string",
"acl": "string",
"pathPrefix": "string",
"enabled": true,
"forcePathStyle": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetS3ConfigurationOptions

Responses

Update server url

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetServerURLOptions

Responses

Update external action links

Authorizations:

BasicAuth

Request Body schema: application/json

Array of objects (ExternalAction)

Responses

Request samples

Payload

Content type

application/json

{"value": [{"url": "string",
"html": "string",
"title": "string",
"description": "string",
"icon": "string",
"color": "string",
"openExternally": true
}
]
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetExternalActionsOptions

Responses

Update custom styles

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomStylesOptions

Responses

Update custom JavaScript

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetCustomJavascriptOptions

Responses

Update hide viewer count

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetHideViewerCountOptions

Responses

Update search indexing

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDisableSearchIndexingOptions

Responses

Enable/disable federation features

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationEnabledOptions

Responses

Set if federation activities are private

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationActivityPrivateOptions

Responses

Set if fediverse engagement appears in chat

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationShowEngagementOptions

Responses

Set local federated username

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationUsernameOptions

Responses

Set federated go live message

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationGoLiveMessageOptions

Responses

Set Federation blocked domains

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetFederationBlockDomainsOptions

Responses

Configure Discord notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (DiscordNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"webhook": "string",
"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetDiscordNotificationConfigurationOptions

Responses

Configure Browser notifications

Authorizations:

BasicAuth

Request Body schema: application/json

object (BrowserNotificationConfiguration)

Responses

Request samples

Payload

Content type

application/json

{"value": {"goLiveMessage": "string",
"enabled": true
}
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SetBrowserNotificationConfigurationOptions

Responses

Get all the webhooks

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}
]

GetWebhooksOptions

Responses

Delete a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

id

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 0
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteWebhookOptions

Responses

Create a single webhook

Authorizations:

BasicAuth

Request Body schema: application/json

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"

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"events": ["CHAT"
]
}

Response samples

200
400
default

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"lastUsed": "2019-08-24T14:15:22Z",
"url": "string",
"events": ["CHAT"
],
"id": 0
}

CreateWebhookOptions

Responses

Get all access tokens

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

[{"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
}
]

GetExternalAPIUsersOptions

Responses

Delete a single external API user

Authorizations:

BasicAuth

Request Body schema: application/json

token

string

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

DeleteExternalAPIUserOptions

Responses

Create a single access token

Authorizations:

BasicAuth

Request Body schema: application/json

name	string
scopes	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"scopes": ["string"
]
}

Response samples

200
400
default

Content type

application/json

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

CreateExternalAPIUserOptions

Responses

Return the auto-update features that are supported for this instance

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"supportsUpdate": true,
"canRestart": true
}

AutoUpdateOptionsOptions

Responses

Begin the auto-update

Authorizations:

BasicAuth

Responses

Response samples

400
default

Content type

application/json

{"message": "string",
"success": true
}

AutoUpdateStartOptions

Responses

Force quit the server and restart it

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

AutoUpdateForceQuitOptions

Responses

Reset YP configuration

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

ResetYPRegistrationOptions

Responses

Get video playback metrics

Authorizations:

BasicAuth

Responses

Response samples

200
400
default

Content type

application/json

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

GetVideoPlaybackMetricsOptions

Responses

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Endpoint to interface with Prometheus

This endpoint interfaces with the Prometheus metrics API.

Learn more about it on the Prometheus API docs

Send a public message to the Fediverse from the server's user

Authorizations:

BasicAuth

Request Body schema: application/json

A single value that is used in the request

string or boolean or Array of strings or number

Responses

Request samples

Payload

Content type

application/json

{"value": "string"
}

Response samples

200
400
default

Content type

application/json

{"message": "string",
"success": true
}

SendFederatedMessageOptions

Responses

Get a paginated list of federated activities

Authorizations:

BasicAuth

query Parameters

offset	integer The number of items to skip before starting to collect the result set
limit	integer The numbers of items to return

Responses

Response samples

200
400
default

Content type

application/json

{"total": 0,
"results": {"timestamp": "2019-08-24T14:15:22Z",
"iri": "string",
"actorIRI": "string",
"type": "string"
}
}

Owncast APIs (0.2.0)

External

Send a system message to the chat

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Send a system message to a single client

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Send a user message to chat Deprecated

Authorizations:

Responses

Response samples

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

SendIntegrationChatMessageOptions

Responses

Send a user action to chat

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Hide chat message

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

ExternalUpdateMessageVisibilityOptions

Responses

Stream title

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

ExternalSetStreamTitleOptions

Responses

Get chat history

Authorizations:

Responses

Response samples

ExternalGetChatMessagesOptions

Responses

Connected clients

Authorizations:

Responses

Response samples

ExternalGetConnectedChatClientsOptions

Responses

Get a user's details

path Parameters

query Parameters

Responses

Response samples

Internal

Get the status of the server

Responses

Response samples

Get list of custom emojis supported in the chat

Responses

Response samples

Gets a list of chat messages

query Parameters

Responses

Response samples

Registers an anonymous chat user

header Parameters

Request Body schema: application/jsonoptional

Request Body schema: application/json
optional