The Blackout API allows you to manage content restrictions based on audiences, rules, and blackout configurations. This API is designed for use with live channels that do not leverage schedule entries.

Key Features

Audience Management: Define and manage audiences and superaudiences.
Rule Administration: Create and configure blackout rules to enforce content restrictions.
Blackout Configuration: Apply blackout settings to live channels.

Audience Management

Audiences and superaudiences define groups of users who are subject to blackout rules. These can be created, modified, and removed using the endpoints below.

Available Endpoints

Endpoint	Description
POST /audiences	Add an audience or superaudience.
DELETE /audiences/{Audience ID}	Delete an audience or superaudience.
GET /audiences/{Audience ID}	Retrieve a specific audience or superaudience.
GET /audiences	Retrieve one or more audiences or superaudiences.
PATCH /audiences/{Audience ID}	Update a specific audience or superaudience.

Rules Administration

Rules define blackout conditions applied to specific audiences. Use the endpoints below to manage blackout rules.

Available Endpoints

Endpoint	Description
POST /rules	Add a blackout rule.
DELETE /rules/{Rule ID}	Delete a blackout rule.
GET /rules	Retrieve one or more blackout rules.
GET /rules/{Rule ID}	Retrieve a specific blackout rule.
PATCH /rules/{Rule ID}	Update a specific blackout rule.

Blackout Configuration

Blackouts are applied to live channels to enforce content restrictions based on defined rules and audiences.

Available Endpoints

Endpoint	Description
POST /channels/{Live Channel ID}/blackouts	Add a blackout configuration to a live channel.
DELETE /channels/{Live Channel ID}/blackouts/{Blackout ID}	Delete a blackout configuration from a live channel.
GET /channels/{Live Channel ID}/blackouts/{Blackout ID}	Retrieve a blackout configuration associated with a specific live channel.
GET /channels/{Live Channel ID}/blackouts	Retrieve all or recently updated blackout configurations for a live channel.
PATCH /channels/{Live Channel ID}/blackouts/{Blackout ID}	Update a specific blackout configuration.

Base URL

Use the following base URL for API requests:

https://services.uplynk.com/api/v4