Skip to main content

livestream_sessions

Creates, updates, deletes, gets or lists a livestream_sessions resource.

Overview

Namelivestream_sessions
TypeResource
Idcloudflare.realtime_kit.livestream_sessions

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
dataobject
successboolean

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_id, app_id, session_idper_page, page_noReturns livestream session details for the given session ID. Retreive the session ID using the Fetch all sessions of an App API.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
app_idstringThe Access application ID.
session_idstringThe session ID.
page_nonumberThe page number from which you want your page search results to be displayed.
per_pagenumberNumber of results per page.

SELECT examples

Returns livestream session details for the given session ID. Retreive the session ID using the Fetch all sessions of an App API.

SELECT
data,
success
FROM cloudflare.realtime_kit.livestream_sessions
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND per_page = '{{ per_page }}'
AND page_no = '{{ page_no }}'
;