Flussonic Media Server API (22.01.1-335)

Download OpenAPI specification:Download

This document is a comprehensive API specification for the Flussonic Media Server.

The Flussonic Media Server API lets you manage the server configuration: retrieving the information about the streams, DVRs, templates, etc., creating/updating, and removing them. To know more about our API's design principles, visit Flussonic HTTP API page.

This API Reference provides you with all the methods, fields, values, and endpoints currently accessible in Flussonic.

Before you proceed, read the following information:

  • server_config represents the server configuration file. Our built-in config parser validates the configuration file structure according to this specification.
  • Some API methods may send extra fields in responses, so your application must be ready to drop them;
  • Do not rely on undocumented fields in the responses as we may modify them at any moment.
  • In further updates of this document, some fields may become deprecated. Such fields will be scheduled for deletion with x-delete-at property with year and month, after which it will no longer exist.

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

stream

Managing streams in Flussonic.

List streams

This API method is one of the most important in whole API, because it gives the list of all streams, including:

  • configured (may not be running at the moment)
  • running (including those that are created via a template and do not have own disk configuration)
  • remote (available from other servers)
  • only recorded

Together with the stream_save method you can manage streams in Flussonic.

You can pass all stream configuration options to query string for filtering, not only specified in the parameters.

This method and stream_get will return effective stream configuration with all templates, overrides, defaults included into this response. It is not exactly what you can see in the disk config. If you have configured this stream in the disk file, then the original disk configuration can be found in the field config_on_disk.

What you get from this API call is not what you write to stream_save.

Authorizations:
query Parameters
select
string
Example: select=name,inputs,stats,dvr.root

Comma-separated list of fields (including nested) that will be returned.

sort
string
Example: sort=-stats.bitrate,name,position

Composite sort direction. Default sort order is named_by (config,user,remote), position, name.

limit
integer
Example: limit=100

Limit select count in collection to N elements. Default value is 100.

cursor
string
Example: cursor=JTI0cG9zaXRpb25fZ3Q9MQ==

Properly encoded analog of offset, allowing to read next bunch of items. We do not offer common offset fields, use please cursor for predictable fetching of quickly changing list of items. More information can be found here

q
string
Example: q=somepattern

Search pattern for different fields like name, title, urls, etc.

Responses

Response samples

Content type
application/json
{
  • "estimated_count": 5,
  • "next": "JTI0cG9zaXRpb25fZ3Q9MA==",
  • "prev": "JTI0cG9zaXRpb25fbHQ9MSYlMjRyZXZlcnNlZD10cnVl",
  • "timing": { },
  • "streams": [