Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
live channels

List live channels

Get a list of all live channels

get/v2/sites/{site_id}/channels/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Query parameters

pageinteger

Sets the page number for pagination. First page is 1.

page_lengthinteger

Sets the page length (number of items you get in the response) for pagination

If page_length is not specified, the default value will be set.

Default: 10

qstring

Allows for querying results

Example: title:+a title

Live channels can be queried by the following attributes:

  • created
  • last_modified
  • status
  • title
  • id
  • tags
  • latency
  • publishing_mode
sortstring

Allows for sorting results

Example: sort=created:dsc

Sort order can be one of asc, dsc

Live channels can be sorted by the following attributes:

  • created
  • last_modified
  • status
  • title

Response

Resources successfully retrieved

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "channels": [
    {
      "schema": "https://schema.jwplayer.com/types/thumbnail.json",
      "id": "Ny05CEfj",
      "created": "2019-09-25T15:29:11.042095+00:00",
      "last_modified": "2019-09-25T15:29:11.042095+00:00",
      "relationships": {
        "protection_rule": {
          "id": "Ny05CEfj"
        }
      },
      "metadata": {
        "custom_params": {
          "param1": "value1"
        },
        "dvr": "on",
        "latency": "default",
        "reconnect_window": 60,
        "simulcast_targets": [
          {
            "stream_key": "ABCDEF123456",
            "stream_url": "rtmps://live.fb",
            "title": "My Facebook Simulcast"
          }
        ],
        "tags": [
          "sports",
          "football"
        ],
        "text_tracks": [
          {
            "label": "English captions",
            "srclang": "en",
            "track_kind": "captions"
          }
        ],
        "title": "Your live channel title"
      },
      "preview_url": "https://api.mux.com/video/v1/314159265358979323846264.m3u8",
      "recent_events": [
        {
          "media_id": "Ny05CEfj",
          "status": "idle"
        }
      ],
      "status": "idle",
      "stream_key": "123456ABCDEF"
    }
  ]
}