Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
broadcast live

List ingest point availability

List the availabilities of Broadcast Live ingest points for a specific format between two dates

get/v2/sites/{site_id}/live/broadcast/ingest/availability/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Query parameters

ingest_format'srt' | 'rtmp' required

Live ingest format

start_datestring date-time
Example:2018-10-02T21:19:36.602019+00:00

First date and time of the availability date range in ISO 8601 format

Default: current date and time (UTC)

end_datestring date-time
Example:2018-10-02T21:19:36.602019+00:00

Last date and time of the availability date range in ISO 8601 format

Default: maximum date and time (31/12/9999 23:59:59)

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

Response

Success

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,
  "items": {
    "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"
  }
}