Skip to navigation
Cloud Playout Channels

Deactivate a channel

This endpoint takes a Cloud Playout channel off air, or cancels its scheduled run if it has not started yet. The channel and everything you configured on it are kept, so you can activate it again later.

How it works

  1. Make a DELETE request to this endpoint with the channelId.

  2. Playout and stream delivery are stopped, and the channel moves to idle. A channel that was already on air passes through stopping first.

  3. The response confirms the change.

A channel that is in draft has never been activated, and a channel that is already idle has nothing left to stop, so deactivating either is refused with a 409. The same applies while a channel is already stopping or being deleted.

Example

A broadcaster takes a seasonal channel off air at the end of the season, keeping its programs ready for next year.

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 to deactivate.

Response

Channel deactivated successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.