Live Streams

Update a live stream

Updates the livestream object.

patch/live-streams/{liveStreamId}

Path parameters

liveStreamIdstring required

The unique ID for the live stream that you want to update information for such as player details.

Request body

namestring

The name you want to use for your live stream.

publicboolean

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.

playerIdstring

The unique ID for the player associated with a live stream that you want to update.

Example request

{
  "name": "My Live Stream Video",
  "playerId": "pl45KFKdlddgk654dspkze",
  "restreams": [
    {
      "name": "My restream server",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "streamKey": "dw-dew8-q6w9-k67w-1ws8"
    }
  ]
}

Response

Success

liveStreamIdstring required

The unique identifier for the live stream. Live stream IDs begin with "li."

namestring

The name of your live stream.

streamKeystring

The unique, private stream key that you use to begin streaming.

publicboolean

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.

playerIdstring

The unique identifier for the player.

broadcastingboolean

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.

createdAtstring date-time

When the player was created, presented in ATOM UTC format.

updatedAtstring date-time

When the player was last updated, presented in ATOM UTC format.

Example response

{
  "streamKey": "dw-dew8-q6w9-k67w-1ws8",
  "createdAt": "2020-01-31T10:17:47Z",
  "assets": {
    "thumbnail": "https://live.api.video/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg",
    "iframe": "<iframe src=\\\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\\\" width=\\\"100%\\\" height=\\\"100%\\\" frameborder=\\\"0\\\" scrolling=\\\"no\\\" allowfullscreen=\\\"\\\"></iframe>",
    "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
    "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr"
  },
  "public": true,
  "restreams": [
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "name": "My restream server"
    },
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "serverUrl": "rtmp://my.broadcast.example.com/app",
      "name": "My restream server"
    }
  ],
  "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
  "name": "My Live Stream",
  "playerId": "pl45d5vFFGrfdsdsd156dGhh",
  "broadcasting": true,
  "updatedAt": "2020-01-31T10:18:47Z"
}

Changes

Changed in 5 of the 50 revisions of this API.1910

Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Sep 11, 2023b32ea09011ae2See the full diff
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 28, 2023ec139d07f5cd2See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the required property to the response with the status
  response-required-property-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f88175See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 400
  optional-response-header-removed
- ●
  removed the request property
  request-property-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history