API Reference

Live Slicer Failover

The Live Slicer Failover API allows you to manage failover groups, assign active Live Slicers, configure failover settings, and control user authorization. This API helps ensure seamless failover switching for live streaming workflows.

Key Features

  • Assign and activate Live Slicers for failover groups.
  • Manage live channels within a failover group.
  • Retrieve and modify failover groups and their configurations.
  • Control user authorization for failover group access.
  • Toggle between Live Slicer and slate as the source feed.
  • Update failover eligibility for Live Slicers.

Failover Group Management

Use the following endpoints to configure and control failover groups and Live Slicer assignments.

Available Endpoints

EndpointDescription
PUT /failover-groups/{Failover Group ID}/activate_slicerSets a failover group's active Live Slicer.
PUT /failover-groups/{Failover Group ID}/channelsAdds or removes live channels from a failover group.
GET /failover-groupsRetrieves all failover groups.
GET /failover-groups/{Failover Group ID}/allowed-ownersRetrieves a list of users authorized to use a failover group.
GET /failover-groups/{Failover Group ID}Retrieves a specific failover group by ID.
PUT /failover-groups/{Failover Group ID}/allowed-ownersGrants or denies authorization to a failover group.
PUT /failover-groups/{Failover Group ID}/set_no_slicerToggles a failover group's feed between a Live Slicer and slate.
PATCH /failover-groups/{Failover Group ID}Updates a failover group's failover mode, automatic failback, or both.
PUT /failover-groups/{Failover Group ID}/slicersUpdates failover eligibility for one or more Live Slicer(s).

Base URL

Use the following base URL:

<https://services.uplynk.com/api/v4>

Workflow

Follow these steps to configure a failover group and manage Live Slicer failover:

  1. Create or retrieve an existing failover group.
    • Use GET /failover-groups to list all failover groups.
    • Use GET /failover-groups/{Failover Group ID} to retrieve a specific failover group.
  2. Configure user authorization.
    • Use PUT /failover-groups/{Failover Group ID}/allowed-owners to grant or revoke access.
  3. Manage live channels in the failover group.
    • Use PUT /failover-groups/{Failover Group ID}/channels to add or remove channels.
  4. Assign and activate a Live Slicer.
    • Use PUT /failover-groups/{Failover Group ID}/activate_slicer to set an active Live Slicer.
    • Ensure automatic failback is disabled before activating a Live Slicer.
  5. Modify failover group settings.
    • Use PATCH /failover-groups/{Failover Group ID} to update failover mode and automatic failback settings.
  6. Toggle between Live Slicer and slate as the source feed.
    • Use PUT /failover-groups/{Failover Group ID}/set_no_slicer to switch feeds.
  7. Update failover eligibility for Live Slicers.
    • Use PUT /failover-groups/{Failover Group ID}/slicers to configure eligible slicers for failover.

This API ensures failover groups are effectively managed, providing redundancy and high availability for live streaming workflows.