---
title: "Update properties of a live stream"
method: PATCH
path: "/v2/sites/{site_id}/live/broadcast/streams/{stream_id}/"
tags: ["broadcast live"]
---

# Update properties of a live stream

`PATCH /v2/sites/{site_id}/live/broadcast/streams/{stream_id}/`

Update a selection of live stream properties

## Path parameters

- `stream_id` string, required — Unique identifier for a resource
- `site_id` string, required — Unique identifier for a resource

## Request body

- StreamUpdateParameters — Parameters for updating a live stream
  - `stream_start` string, date-time, nullable — Start time for the stream in ISO 8601 format **NOTE**: This value can only be changed **prior to starting the stream**.
  - `stream_end` string, date-time, nullable — End time for the stream in ISO 8601 format **NOTE**: This value can only be changed **prior to stopping the stream**.
  - `enable_live_to_vod` boolean, nullable — Controls if a video on demand (VOD) asset is automatically created once the live stream ends **NOTE**: This value can only be changed **prior to stopping the stream**.
  - `live_to_vod_method` 'hosted_capture' | 'renditions_capture', nullable — Controls how Live-to-VOD capture is performed once the stream ends **Possible values**: - `hosted_capture`: The stream is captured using the hosted capture flow. - `renditions_capture`: The stream is captured directly from the output renditions, producing a `renditions` (CMAF VOD) media. **NOTE**: This value can only be changed **prior to stopping the stream**.

## Response `200`

Success

- LiveStreamObjectSchema — Schema object for a live stream
  - `schema` string
  - `id` string, nullable — Unique identifier for this resource
  - `created` string, date-time, nullable — Timestamp of when the live stream was created
  - `last_modified` string, date-time, nullable — Timestamp of when the live stream was last modified
  - `type` string, nullable — Unique type label for this resource
  - `relationships` object, nullable — Related resources
  - `metadata` LiveStreamMetadata — Schema object for a live stream's metadata
    - `status` 'capturing' | 'captured' | 'creating' | 'deleting' | 'destroying' | 'failed' | 'idle' | 'ready' | 'requested' | 'scheduled' | 'starting' | 'stopped' | 'stopping' | 'streaming' — The current live stream status.
    - `ingest` object, nullable — Ingest information for the live stream.
    - `playout` LiveStreamPlayout — Live stream playout information
      - `hls` string, nullable — HLS URL for playout
      - `dash` string, nullable — DASH URL for playout
      - `availability` 'not_available' | 'preview' | 'available' — Availability of the playout This can be used to signal whether public playback should commence or not.
    - `title` string, nullable — Title of the live stream This value matches the media object.
    - `drm` boolean — Whether or not the live stream should use DRM to protect the content
    - `stream_start` string, date-time, nullable — Start time for the live stream
    - `stream_end` string, date-time, nullable — End time of the live stream
  - `stream_type` '24/7' | 'event', nullable — The type of live stream.
  - `profile_name` string, nullable — The associated Preset's name.
  - `cluster_region` string, nullable — The associated Cluster's name.
  - `ingest_format` 'hls_pull' | 'rtmp' | 'rtp' | 'rtp_fec' | 'srt' | 'srt_pull' | 'zixi_push', nullable — The ingest format used for the live stream.
  - `dvr_window` 30 | 3600 | 7200 | 10800 | 14400 | 18000 | 21600 | 25200 | 28800 | 32400 | 36000 | 39600 | 43200 | 46800 | 50400 | 54000 | 57600 | 61200 | 64800 | 68400 | 72000 | 75600 | 79200 | 82800 | 86400 — The DVR window set on the live stream.
  - `audio_definitions` AudioDefinition[], nullable — Audio definitions for the live stream (i.e. language and PID configuration)
    - `pid` integer, nullable — Associated PID (Packet Identifier) for the definition
    - `language` string, nullable — Associated language code for the definition
  - `caption_definitions` CaptionDefinition[], nullable — Caption definitions for the live stream, such as name, language, type, and page number configuration)
    - `name` string — Associated name identifier for the definition
    - `language` string — Associated language code for the definition. This is either `ISO-639-2B` or `ISO-639-2T`
    - `type` object — Associated caption type for the definition This is either `TELETEXT` or `CEA608708`
  - `use_legacy_ott_params` boolean — Whether or not the live stream is using legacy OTT parameters. The flag configures your Media to have the legacy VCH custom params, which may be desirable when migrating to the integrated version of Broadcast Live.
  - `enable_live_to_vod` boolean — Whether or not the live stream has live to VOD enabled. With live2vod enabled, the livestream will be converted to a hosted Media at the end of the stream.
  - `live_to_vod_method` 'hosted_capture' | 'renditions_capture' — Live-to-VOD capture method configured for this stream **Possible values**: - `hosted_capture`: The stream is captured using the hosted capture flow. - `renditions_capture`: The stream is captured directly from the output renditions, producing a `renditions` (CMAF VOD) media.
  - `mpd_profile` string, nullable — The profile type of the DASH MPD for this live stream.
  - `stream_warmup` integer, nullable — Number of minutes before `stream_start` that the stream was configured to start early

## Other responses

- `400` — Bad Request The request either lacks certain attributes or contains malformed/invalid attributes.
- `404` — Not Found The requested asset could not be found.

---

[API](https://skmtc.dev/jwplayer/apis/management-api-v2.md) · [All operations](https://skmtc.dev/jwplayer/apis/management-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jwplayer/management-api-v2/revisions/180db7cada27/schema)