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:

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
Failover Group ID Required	Replace this variable with the system-defined ID assigned to the desired failover group. Use the Get All Failover Groups endpoint to retrieve a list of failover groups and their system-defined ID.

Response

The response for a successful request contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint that returns this failover group.
@type	String	Returns FailoverGroup.
id	String	Identifies this failover group by its system-defined ID.
owner	String	Indicates the system-defined ID for the user that owns this failover group.
name	String	Indicates the name assigned to this failover group.
hot_warm	Integer	Indicates whether all Live Slicers within this failover group will be allowed to encode and store content. Valid values are: _ 0: Hot-Hot mode _ 1: Hot-Warm mode * #: Flexible Hot-Warm mode. # represents the maximum number of Live Slicers that will be allowed to encode and store content. Example: A value of 4 indicates that the primary Live Slicer and up to 3 backup Live Slicers are allowed to encode and store content. All other backup Live Slicers will operate in warm mode.
mode	String	Indicates how our system chooses a Live Slicers upon failover. Valid values are: prioritized	flat
auto_failback	Boolean	Indicates whether our system will automatically switch back to the primary Live Slicer when it resumes a healthy state.
failover_time	Integer	Indicates the date and time, in Unix time (milliseconds), for the last instance in which failover occurred.
active_slicer_id	String	Indicates the system-defined ID for the active Live Slicer. Our system uses this Live Slicer's feed to generate your live stream. If the source for the failover group's feed has been switched to missing content slate, then this property returns no_slicer.
channels	List of Dictionaries	Contains a list of the live channels associated with this failover group.
slicers	List of Dictionaries	Contains a list of Live Slicers associated with this failover group.

channels List

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

Name	Data Type	Description
id	String	Identifies this live channel by its system-defined ID.
desc	String	Indicates the name assigned to this live channel.

slicers List

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

Name	Data Type	Description
id	String	Identifies this Live Slicer by its system-defined ID.
blacklist_until	Integer	Indicates until when, in Unix time (milliseconds), an unhealthy Live Slicer will be ineligible to become the failover group's active Live Slicer. Key information: _ If a Live Slicer is still unhealthy after the specified timestamp, then its ineligibility window will be extended. _ This property returns 0 for healthy Live Slicers that have not been denied eligibility due to health status.
order	Integer	Indicates the order, starting from 1, in which our system will choose Live Slicers upon failover. If the failover group uses flat mode (i.e., random Live Slicer selection), then this property will always return 1.
status	Dictionary	Contains the Live Slicer's status and thumbnail URL.
hostname	String	Indicates the Live Slicer's hostname.
enabled	Boolean	Indicates whether failover has been enabled on the Live Slicer.

status Dictionary

The status dictionary contains the following properties:

Name	Data Type	Description
state	Integer	Indicates the Live Slicer's status. Valid values are: _ -1: Inactive _ 0: Slicing _ 1: Ad Break _ 2: Replacing Content * 3: Blackout Learn more.
thumb_url	String	Indicates the URL to a thumbnail preview of the Live Slicer's output.

Sample Request/Response

The code below (Python 3) shows how to retrieve a failover group.

This code imports names from the api_auth module for V4 APIs (see below).

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": null,
	"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
		}
	]
}