Get Publishing Target

Retrieves the configuration for a specific publishing targetRefers to a configuration that identifies the URL to which your content may be published. A publishing schedule leverages a publishing target configuration to syndicate a live channel or a live event to a social media platform..

Request

Request syntax:

GET /syndication-target/Publishing Target ID

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
Publishing Target ID RequiredReplace this variable with the system-defined ID assigned to the desired publishing target configuration. Use the Get Multiple Publishing Targets endpoint to retrieve a list of publishing targets and their system-defined ID.

Response

The response for a successful request contains the following properties:

NameData TypeDescription
@idStringIndicates the relative path to an endpoint that returns this publishing target.
@typeStringReturns SyndicationTarget.
descriptionStringIndicates a description for the social media or content distribution platform.
idStringIdentifies this publishing target by its system-defined ID.
platformStringIdentifies a social media or content distribution platform by its case-sensitive name. Valid values are: AWS Elemental MediaConnect CustomFacebook Pluto TVTikTokTwitchYouTube
platform_configDictionaryContains additional platform-specific settings.
statusStringIndicates the publishing target's status. Valid values are: activeIndicates that one or more publishing schedules that leverage this publishing target are in the active state.stoppedIndicates that none of the publishing schedules that leverage this publishing target are in the active or error state.errorIndicates that one or more publishing schedules that leverage this publishing target are in the error state.
target_protocolStringIndicates the protocol through which your content will be published. Valid values are: rtmprtmpshlshls-pushzixisrtrist
target_streamStringReturns ******. This value represents either a stream URL or a stream key when the integrated parameter is set to false.
platform_config Dictionary

The platform_config dictionary contains the following platform-specific settings:

NameData TypeDescription
clipping_profile_idStringFacebook and YouTube (Integrated Authentication) Indicates the Clipping profile, whose credentials will be used to authenticate to Facebook or YouTube, by its system-defined ID. Use the Get Syndication Publishing-Compatible Clipping Profiles endpoint to retrieve Clipping profiles and their system-defined IDs.
hostStringAWS Elemental MediaConnect, Pluto TV, and ZIXI (Push) Indicates the hostname or IP address for the desired platform or your Zixi-enabled device.
integratedBooleanFacebook and YouTube Indicates how your live stream will be published to Facebook or YouTube. Valid values are: true: Live streams will be published using integrated authentication to either: + The Facebook page identified by the page_id property. + A YouTube Studio dashboard. false: Live streams will be published to the stream URL identified by the target_stream property.
page_idStringFacebook Only Identifies a Facebook page by its system-defined ID. Your live stream will be published to this page. Learn more (Live Channels). Learn more (Live Events).
passwordStringAWS Elemental MediaConnect, Pluto TV, and ZIXI (Push) Returns ******. This value represents the password of the stream to which your content will be published.
portIntegerIndicates the port for the desired platform or platform-enabled device. Zixi-enabled devices and servers typically listen on port 2088.
re_scheduleBooleanFacebook Only Indicates whether our service will create and then publish a new Facebook live event upon reaching Facebook's live event time limit.
remote_idStringReserved for future use.
stream_idStringAWS Elemental MediaConnect, Pluto TV, and ZIXI (Push) Returns ******. This value represents the ID of the stream to which your content will be published.
typeStringReturns push.

Sample Request/Response

Call the get_publishing_target module (Python 3) to get a publishing target configuration. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_publishing_target()

    def _get_publishing_target(self):
        publishing_target_id = '587be125932f4428b83e4435e41503b7'
        url = "{}{}{}".format(self.host, "/api/v4/syndication-target/", publishing_target_id)

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

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

        print(response.json())

PublishingTarget().run()

Response:

{
	"@id": "/api/v4/syndication-target/587be125932f4428b83e4435e41503b7",
	"@type": "SyndicationTarget",
	"id": "587be125932f4428b83e4435e41503b7",
	"platform": "Facebook",
	"description": "Facebook publishing",
	"target_protocol": "rtmp",
	"target_stream": "******",
	"status": "stopped"
}