Get Failover Group

Retrieves a failover group by its system-defined ID.

Request

Request syntax:

GET /failover-groups/Failover Group ID

Request URL variable:

Define the following variable when submitting the above request:

Response

The response for a successful request contains the following properties:

channels List

The channels list describes each live channel associated with your failover group via the following properties:

slicers List

The slicers list describes each Live Slicer associated with your failover group via the following properties:

status Dictionary

The status dictionary contains the following properties:

Sample Request/Response

Call the get_failover_group module (Python 3) to retrieve a failover group. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_failover_group()

    def _get_failover_group(self):
        failover_group_id = 'e8d6b5cb940c40cc9ec6ad081a38f3f0' # Replace with the ID for the desired failover group.
        url = "{}{}{}".format(self.host, "/api/v4/failover-groups/", failover_group_id)

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

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

        print(response.json())

FailoverGroup().run()

Response:

{
	'@id': '/api/v4/failover-groups/9852b8646dea4cd0a48f5e0ffaa4f8b3',
	'@type': 'FailoverGroup',
	'owner': 'ab533864a92b46a1a286cdd49b0a9bd3',
	'id': '9852b8646dea4cd0a48f5e0ffaa4f8b3',
	'name': 'My Failover Group',
	'hot_warm': 0,
	'mode': 'prioritized',
	'auto_failback': True,
	'failover_time': 1576107800205,
	'active': None,
	'active_slicer_id': 'news01',
	'channels': [{
			'id': '478f6d24e1a643049cdba0c544830752',
			'desc': 'Broadcast01'
		}, {
			'id': 'aad717c2fda649a3b213c56c94b529f4',
			'desc': 'Broadcast02'
		}
	],
	'slicers': [{
			'id': 'news01',
			'blacklist_until': 0,
			'order': 1,
			'status': {
				'state': 0,
				'thumb_url': 'https://x-default-stgec.uplynk.com/ausw/slices/d7b/...000009C.jpg'
			},
			'hostname': '101-174-253-64.slicer.uplynk.net',
			'enabled': True
		}, {
			'id': 'news02',
			'blacklist_until': 0,
			'order': 2,
			'status': {
				'state': 0,
				'thumb_url': 'https://x-default-stgec.uplynk.com/ausw/slices/d7b/...000003E.jpg'
			},
			'hostname': '104-174-253-63.slicer.uplynk.net',
			'enabled': True
		}
	]
}