---
title: "POST /GetStream"
method: POST
path: "/GetStream"
---

# POST /GetStream

`POST /GetStream`

Gets information about the active (live) stream on a specified channel.

## Request body

- object
  - `channelArn` string, required — Channel ARN for stream to be accessed.

## Response `200`

Success

- GetStreamResponse
  - `stream` object — <p/>
    - `channelArn` string — Channel ARN for the stream.
    - `health` 'HEALTHY' | 'STARVING' | 'UNKNOWN' — The stream’s health.
    - `playbackUrl` string — URL of the master playlist, required by the video player to play the HLS stream.
    - `startTime` string, date-time — Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
    - `state` 'LIVE' | 'OFFLINE' — The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    - `streamId` string — Unique identifier for a live or previously live stream in the specified channel.
    - `viewerCount` integer — A count of concurrent views of the stream. Typically, a new view appears in <code>viewerCount</code> within 15 seconds of when video playback starts and a view is removed from <code>viewerCount</code> within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

## Other responses

- `480` — ResourceNotFoundException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — ChannelNotBroadcasting

---

[API](https://skmtc.net/aws/apis/ivs.md) · [All operations](https://skmtc.net/aws/apis/ivs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ivs/versions/32a77504a115/schema)