---
title: "Update a live stream"
method: PATCH
path: "/live-streams/{liveStreamId}"
tags: ["Live Streams"]
---

# Update a live stream

`PATCH /live-streams/{liveStreamId}`

Updates the livestream object.

## Path parameters

- `liveStreamId` string, required

## Request body

- LiveStreamUpdatePayload
  - `name` string — The name you want to use for your live stream.
  - `public` boolean — Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos).
  - `record` boolean — Use this to indicate whether you want the recording on or off. On is true, off is false.
  - `playerId` string — The unique ID for the player associated with a live stream that you want to update.

## Response `200`

Success

- LiveStream
  - `liveStreamId` string, required — The unique identifier for the live stream. Live stream IDs begin with "li."
  - `name` string — The name of your live stream.
  - `streamKey` string — The unique, private stream key that you use to begin streaming.
  - `record` boolean — Whether you are recording or not.
  - `public` boolean — Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos).
  - `assets` LiveStreamAssets
    - `hls` string, uri — The http live streaming (HLS) link for your live video stream.
    - `iframe` string — The embed code for the iframe containing your live video stream.
    - `player` string, uri — A link to the video player that is playing your live stream.
    - `thumbnail` string, uri — A link to the thumbnail for your video.
  - `playerId` string — The unique identifier for the player.
  - `broadcasting` boolean — Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not.
  - `createdAt` string, date-time — When the player was created, presented in ISO-8601 format.
  - `updatedAt` string, date-time — When the player was last updated, presented in ISO-8601 format.

## Other responses

- `400` — Bad Request

## Changes

- **2022-04-28** `f9532dd3578c` — 2 info
  - the endpoint scheme security `apiKey` was added to the API
  - the endpoint scheme security `bearerAuth` was removed from the API
- **2022-02-07** `2a4d90a64f88` — 1 breaking, 7 warning, 5 info
  - removed the required property `restreams` from the response with the `200` status
  - the optional response header `X-RateLimit-Limit` removed for the status `200`
  - the optional response header `X-RateLimit-Limit` removed for the status `400`
  - the optional response header `X-RateLimit-Remaining` removed for the status `200`
  - …9 more

[Change history](https://skmtc.dev/apivideo/apis/api-video/changes/live-streams/:liveStreamId/patch.md)

---

[API](https://skmtc.dev/apivideo/apis/api-video.md) · [All operations](https://skmtc.dev/apivideo/apis/api-video/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apivideo/api-video/revisions/64665da540fd/schema)