Get Blackout

Retrieves a blackout configuration associated with a live channel.

Request

Request syntax:

GET /channels/Live Channel ID/blackouts/Blackout ID

Define the following variables when submitting the above request:

Response

A successful request returns a 200 OK response that contains the following properties:

@included List

The @included list describes the blackout rule associated with this blackout configuration via the following properties:

Sample Request/Response

Call the get_blackout module (Python 3) to retrieve a blackout configuration. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams
channel_id = '02ed9f65570746528e7b3d0628960025' # Replace with the ID for the desired live channel.
blackout_id = 'f29106a8d8994dd7886c7f8aedab3b77' # Replace with the ID for the desired blackout configuration.

class Blackout:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        self._get_blackout()

    def _get_blackout(self):
        url = "{}{}{}{}{}".format(self.host, "/api/v4/channels/", channel_id, "/blackouts", blackout_id)

        headers = {'Content-Type': 'application/json'}

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({}), headers=headers
        )

        print(response.json())

Blackout().run()

Response:

{
	'@id': '/api/v4/channels/02ed9f65570746528e7b3d0628960025/blackouts/f29106a8d8994dd7886c7f8aedab3b77',
	'@type': 'Blackout',
	'@included': [{
			'@id': '/api/v4/rules/c2eb5a555b9d45b7a43552f65a268075',
			'@type': 'Rule',
			'id': 'c2eb5a555b9d45b7a43552f65a268075',
			'alternate_content_loop': True,
			'owner': 'abc123def456ghi789jkl012mno345pq',
			'alternate_content_type': 'asset',
			'desc': 'My New Rule',
			'all_viewers': True,
			'created': '2019-07-30T17:54:56.290Z',
			'alternate_content_id': '062048d702734ca6a38f3e7f8e4f4488',
			'audience': '',
			'external_id': ''
		}
	],
	'id': 'f29106a8d8994dd7886c7f8aedab3b77',
	'owner': 'abc123def456ghi789jkl012mno345pq',
	'channel': '02ed9f65570746528e7b3d0628960025',
	'blackout_id': 'BNA',
	'desc': 'Blackout North America',
	'external_id': '',
	'rules': ['c2eb5a555b9d45b7a43552f65a268075']
}