Get All Failover Groups

Retrieves all failover groups.

Request

Request syntax:

GET /failover-groups

Response

The response for a successful request contains the following properties:

items List

The items list describes each failover group via 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_all_failover_groups module (Python 3) to retrieve all failover groups. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_failover_groups()

    def _get_failover_groups(self):
        url = "{}{}".format(self.host, "/api/v4/failover-groups")

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

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

        print(response.json())

FailoverGroups().run()

Response:

{
	'@id': '/api/v4/failover-groups',
	'@type': 'Collection',
	'items': [{
			'@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
				}
			]
		}, {
			'@id': '/api/v4/failover-groups/054d58556a7441cbbe71d4fb7f366422',
			'@type': 'FailoverGroup',
			'owner': 'cb233864a92b46a1a286cdd49b0a9bc8',
			'id': '054d58556a7441cbbe71d4fb7f366422',
			'name': 'Premium Events',
			'hot_warm': 0,
			'mode': 'prioritized',
			'auto_failback': True,
			'failover_time': 1576090867072,
			'active': None,
			'active_slicer_id': 'sports01',
			'channels': [{
					'id': 'c8929b67f1354607877b319edb0c01af',
					'desc': 'Entertainment'
				}, {
					'id': '6c1455e88af8428e999bacf69c7dd203',
					'desc': 'Sports'
				}
			],
			'slicers': [{
					'id': 'sports01',
					'blacklist_until': 0,
					'order': 3,
					'status': {
						'state': -1,
						'thumb_url': ''
					},
					'hostname': '190-16-26-22.slicer.uplynk.net',
					'enabled': False
				}, {
					'id': 'sports02',
					'blacklist_until': 0,
					'order': 4,
					'status': {
						'state': -1,
						'thumb_url': ''
					},
					'hostname': '193-16-26-4.slicer.uplynk.net',
					'enabled': False
				}
			]
		}
	],
	'total_items': 2
}