Owncast (0.0.5)

Download OpenAPI specification:Download

Gabe Kangas: gabek@real-ity.com URL: http://owncast.online

Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. The following APIs represent the state in the development master branch.

Authentication

AdminBasicAuth

The username for admin basic auth is admin and the password is the stream key.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

Admin

Admin operations requiring authentication.

Server status and broadcaster

Authorizations:

AdminBasicAuth

Responses

Response samples

200

Content type

application/json

{"broadcaster": {"remoteAddr": "172.217.164.110",
"time": "2020-10-06T23:20:44.588649-07:00",
"streamDetails": {"width": 640,
"height": 480,
"frameRate": 24,
"videoBitrate": 1500,
"videoCodec": "mp4a",
"audioBitrate": 256,
"audioCodec": "aac",
"encoder": "obs-output module (libobs version 25.0.8)"
}
},
"online": true,
"viewerCount": 3,
"overallPeakViewerCount": 4,
"sessionPeakViewerCount": 4,
"versionNumber": "0.0.3",
"disableUpgradeChecks": false
}

Disconnect Broadcaster

Disconnect the active inbound stream, if one exists, and terminate the broadcast.

Authorizations:

AdminBasicAuth

Responses

Response samples

200

Content type

application/json

Example

{"success": true,
"message": "context specific success message"
}

Return a list of currently connected clients

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

Authorizations:

AdminBasicAuth

Responses

Response samples

200

Content type

application/json

[{"connectedAt": "2020-10-06T23:20:44.588649-07:00",
"messageCount": 3,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36",
"ipAddress": "172.217.164.110",
"username": "coolperson42",
"clientID": "2ba20dd34f911c198df3218ddc64c740",
"geo": {"countryCode": "US",
"regionName": "California",
"timeZone": "America/Los_Angeles"
}
}
]

Return recent log entries

Returns server logs.

Authorizations:

AdminBasicAuth

Responses

Response samples

200

Content type

application/json

[{"message": "Owncast v0.0.0-localdev (unknown)",
"level": "info",
"time": "2020-10-29T18:35:34.422386-07:00"
},
{"message": "Web server running on port: 8080",
"level": "info",
"time": "2020-10-29T18:35:35.011731-07:00"
},
{"message": "RTMP server is listening for incoming stream on port: 1935",
"level": "info",
"time": "2020-10-29T18:35:35.011823-07:00"
}
]

Return recent warning and error logs.

Authorizations:

AdminBasicAuth

Responses

Response samples

200

Content type

application/json

[{"message": "Owncast v0.0.0-localdev (unknown)",
"level": "info",
"time": "2020-10-29T18:35:34.422386-07:00"
},
{"message": "Web server running on port: 8080",
"level": "info",
"time": "2020-10-29T18:35:35.011731-07:00"
},
{"message": "RTMP server is listening for incoming stream on port: 1935",
"level": "info",
"time": "2020-10-29T18:35:35.011823-07:00"
}
]

Update Stream Key. Pre-release, do not use.

Change the stream key in memory, but not in the config file. This will require all broadcasters to be reconfigured to connect again.

Authorizations:

AdminBasicAuth

Request Body schema: application/json

key

string

Responses

Request samples

Payload

Content type

application/json

{"key": "string"
}

Response samples

200

Content type

application/json

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

Change the extra page content. Pre-release, do not use.

Change the extra page content in memory, but not on disk.

Authorizations:

AdminBasicAuth

Request Body schema: application/json

content

string

Responses

Request samples

Payload

Content type

application/json

{"content": "string"
}

Response samples

200

Content type

application/json

{"su