Skip to Content
Mux Docs: Home
List live streams
get

Lists the live streams that currently exist in the current environment.

curl https://api.mux.com/video/v1/live-streams \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}
Request path & query params
limit
integer
(default: 25)

Number of items to include in the response

page
integer
(default: 1)

Offset by this many pages, of the size of limit

stream_key
string

Filter response to return live stream for this stream key only

status
string
Possible values: "active""idle""disabled"

Filter response to return live streams with the specified status only. idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams can be published.

get
200
/video/v1/live-streams
Response
(application/json)
{
  "data": [
    {
      "stream_key": "831b5bde-cd8a-5bc4-115d-4ba34b19f481",
      "status": "idle",
      "reconnect_window": 60,
      "playback_ids": [
        {
          "policy": "public",
          "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
        }
      ],
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ]
      },
      "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
      "created_at": "1609937654",
      "latency_mode": "standard",
      "max_continuous_duration": 43200
    },
    {
      "stream_key": "d273c65e-1fc8-27dc-e9ef-56144cbceb3a",
      "status": "idle",
      "reconnect_window": 60,
      "recent_asset_ids": [
        "SZs02xxHgYdkHp00OSCjJiHUHqzVQZNU332XPXRxe341o",
        "e4J9cwb5tjVxMeeV8201dC00i800ThPKKGT2SEN002dHH2s"
      ],
      "playback_ids": [
        {
          "policy": "public",
          "id": "00zOcribkUmXqXHzBTpflk2771BRTcKATqPjWf7JHpuM"
        }
      ],
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ]
      },
      "id": "B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc",
      "created_at": "1607587513",
      "latency_mode": "standard",
      "max_continuous_duration": 43200
    }
  ]
}