Fetch all livestreams

GET/accounts/{account_id}/realtime/kit/{app_id}/livestreams

Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the exclude_meetings query parameter.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

Path ParametersExpand Collapse

account_id: string

The account identifier tag.

maxLength32

app_id: string

The app identifier tag.

Query ParametersExpand Collapse

end_time: optional string

Specify the end time range in ISO format to access the live stream.

formatdate-time

exclude_meetings: optional boolean

Exclude the RealtimeKit meetings that are livestreamed.

page_no: optional number

The page number from which you want your page search results to be displayed.

per_page: optional number

Number of results per page.

sort_order: optional "ASC" or "DSC"

Specifies the sorting order for the results.

One of the following:

"ASC"

"DSC"

start_time: optional string

Specify the start time range in ISO format to access the live stream.

formatdate-time

status: optional "LIVE" or "IDLE" or "ERRORED" or "INVOKED"

Specifies the status of the operation.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

ReturnsExpand Collapse

data: array of object { id, created_at, disabled, 9 more }

id: string

ID of the livestream.

formatuuid

created_at: string

Timestamp the livestream was created at, in ISO format.

formatdate-time

disabled: boolean

Specifies if the livestream is disabled.

external_id: string

ID of the underlying Cloudflare Stream live input.

ingest_server: string

The server URL to which the RTMP encoder sends the video and audio data.

manual_ingest: boolean

Specifies if the livestream is ingested manually by an RTMP encoder.

meeting_id: string

ID of the meeting being livestreamed, if any.

name: string

Name of the livestream.

playback_url: string

The web address that viewers can use to watch the livestream.

status: "LIVE" or "IDLE" or "ERRORED" or 2 more

Status of the livestream.

One of the following:

"LIVE"

"IDLE"

"ERRORED"

"INVOKED"

"METRICS_READY"

stream_key: string

Unique key for accessing each livestream. Empty if the livestream is disabled.

updated_at: string

Timestamp the livestream was last updated at, in ISO format.

formatdate-time

paging: object { end_offset, start_offset, total_count }

end_offset: number

start_offset: number

total_count: number

minimum0

success: boolean

Fetch all livestreams

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/livestreams \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "data": [
    {
      "created_at": "2023-07-15T07:08:26.634Z",
      "disabled": false,
      "external_id": "7de6a3fec0f9c05bf1df140950d3a237",
      "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "ingest_server": "rtmps://live.cloudflare.com:443/live/",
      "manual_ingest": false,
      "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
      "name": "test",
      "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
      "status": "LIVE",
      "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4",
      "updated_at": "2023-07-15T07:08:40.726Z"
    }
  ],
  "paging": {
    "end_offset": 1,
    "start_offset": 1,
    "total_count": 1
  },
  "success": true
}

Returns Examples

{
  "data": [
    {
      "created_at": "2023-07-15T07:08:26.634Z",
      "disabled": false,
      "external_id": "7de6a3fec0f9c05bf1df140950d3a237",
      "id": "b60ef3da-fbbb-441b-9168-8235b0035248",
      "ingest_server": "rtmps://live.cloudflare.com:443/live/",
      "manual_ingest": false,
      "meeting_id": "bbb87945-df1c-49d9-8159-262a7ae6cfde",
      "name": "test",
      "playback_url": "https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8",
      "status": "LIVE",
      "stream_key": "f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4",
      "updated_at": "2023-07-15T07:08:40.726Z"
    }
  ],
  "paging": {
    "end_offset": 1,
    "start_offset": 1,
    "total_count": 1
  },
  "success": true
}