Delete Blackout

Deletes a blackout configuration from a live channel.

Request

Request syntax:

DELETE /channels/Live Channel ID/blackouts/Blackout ID

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Live Channel ID Required	Identifies a live channel by its system-defined ID.
Blackout ID Required	Identifies a blackout configuration by its system-defined or external ID. Use the Get Multiple Blackouts endpoint to retrieve a list of blackout configurations and their IDs.

Response

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

Name	Data Type	Description
@id	String	Indicates the relative path to the requested endpoint.
@type	String	Returns Blackout.
message	String	Returns Deleted.

Sample Request/Response

Call the delete_blackout module (Python 3) to delete a blackout configuration from a live channel. This module imports names from the api_auth module.

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

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

    def run(self):
        """
        Deletes a blackout configuration.
        """
        self._delete_blackout()

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

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

        print(response.json())

DeleteBlackout().run()

Response:

{
	'@id': '/api/v4/channels/Hak3zjnPLSW5o0j8GMpzRMsa/blackouts/degf8923f093kfd932kd9fa4',
	'@type': 'Blackout',
	'message': 'Deleted'
}