Skip to navigation
Cloud Playout Channels

Get channel by ID

This endpoint retrieves a single Cloud Playout channel using its unique identifier. Use it to check a channel’s current status and its playback details.

How it works

  1. Make a GET request to this endpoint, replacing {channelId} with the UUID that FastPix returned when the channel was created.

  2. The response contains the channel, including its status, the playbackUrl your viewers watch, and the identifiers of the live streams FastPix created for it.

Channels belong to the workspace they were created in, so a channel that belongs to a different workspace is not found.

Example

A monitoring dashboard polls this endpoint to show whether a channel is still in draft, is scheduled to go on air, is running, or has been taken off air.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the channel, returned by FastPix when the channel was created.

Response

Channel details fetched successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
A Cloud Playout channel.