Get CSL

Retrieves a CSL slicer.

Request

Request syntax:

GET /managed-slicer/slicers/CSL Slicer 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
CSL Slicer ID RequiredReplace this variable with the system-defined ID assigned to the desired CSL slicer. Use the Get All CSL Slicers endpoint to retrieve a list of CSL slicers and their system-defined IDs.

Response

The response for a successful request contains the following properties:

NameData TypeDescription
@idStringIndicates the relative path that returns this resource.
@typeStringReturns ManagedSlicer.
slicerDictionaryContains information that describes this slicer.
metaDictionaryReserved for future use.

slicer Dictionary

The slicer dictionary describes a slicer through the following properties:

NameData TypeDescription
creation_timeStringIndicates the timestamp (UTC) at which the slicer was created. Example: Sep 28, 2023 9:21:36 PM
docker_tagStringReserved for future use.
ingest_point_idStringIndicates an ingest point by its system-defined ID. Use the Get Ingest Point endpoint to retrieve an ingest point by its system-defined ID.
isolation_requiredBooleanIndicates whether the slicer will run on a private host.
profileStringProvides basic information about the slicer's encoding profile. Specifically, it indicates the encoding profile's ID, frames per second, and maximum height. Example: 'profile': '{"max_bframes": 3, "profile": "high", "aoKbps": null, "skipF": 0, "fps": 30, "vKbps": 2400, "aKbps": 128, "aMaxChannels": 2, "maxW": 1280, "isHD": false, "maxH": 720, "preset": "veryfast", "threads": 4, "vPasses": 2, "EncryptionKey": 1, "id": 4}',
server_image_idStringReserved for future use.
server_regionStringIndicates the slicer's region by its name.
server_region_idStringIndicates the slicer's region by its system-defined ID. Use the Get CSL Regions endpoint to retrieve a list of regions and their system-defined IDs.
slicer_api_urlStringIndicates the URL that accepts Live Slicer API requests for this slicer.
slicer_configStringIndicates this slicer's slicer configuration. Example: 'slicer_config': 'slicerID:slicer_abc338_fgad12_28Sep2022_1664400095\nusername:[email protected]\napikey:*****\ninput:rtmp\nport:47965\nssl_port:47968\napi_port:47966\nmanual_ip:ingest-prod-1-us-east-1.mss.aws.oath.cloud\nrtmp_url:rtmp://0.0.0.0:47965/mss/d7182b4c-9b72-465d-b218-9c5e1e0fe3gf\n',
slicer_domain_nameStringIndicates the domain assigned to the slicer.
slicer_idStringIndicates the slicer's ID. Use this ID to identify this slicer when setting up a live channel or a live event.
slicer_portsDictionaryContains the slicer's ports.
slicer_secure_stream_urlStringIndicates the encrypted URL to which you may push your feed. This slicer will ingest the content that is pushed to this URL.
slicer_software_versionStringIndicates the slicer software version.
slicer_stream_keyStringRTMP or RTMPS Indicates the slicer's stream key.
slicer_stream_urlStringIndicates the URL to which you may push your feed. This slicer will ingest the content that is pushed to this URL.
slicer_versionStringIndicates a slicer version by its system-defined ID. This slicer runs on this slicer version.
source_ip_addressStringIndicates the IP address of the computer generating the UDP multicast stream.
statusStringIndicates the slicer's status (e.g., INITIALIZING). Learn more.
stream_type_idStringReserved for future use.
slicer_ports Dictionary

The slicer_ports dictionary describes each port associated with this slicer through the following properties:

NameData TypeDescription
portNumberUDP Only Indicates the port on which the slicer will listen for the UDP stream.
api_portNumberIndicates the port on which the slicer will listen for API calls.
ssl_portNumberIndicates the port on which the slicer will expose the authenticated API over TLS. Use this parameter to allow the slicer to communicate with the Live Events Dashboard without causing mixed content blocking. Learn more.

Sample Request/Response

Call the get_csl_slicer module (Python 3) to retrieve a CSL slicer. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_csl_slicer()

    def _get_csl_slicer(self):
        csl_slicer_id = '2803da54cb8e47668f36908bef564fee'  # Replace with the desired CSL slicer ID.
        url = "{}{}{}".format(self.host, "/api/v4/managed-slicer/slicers/", csl_slicer_id)

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

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

        print(response.json())

CSLSlicer().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers/262cb37a4c254df9946145917f3ce629',
	'@type': 'ManagedSlicer',
	'slicer': {
		'slicer_id': 'basketball_slicer',
		'status': 'INITIALIZING',
		'server_region': 'us-east-2',
		'slicer_version': 'STABLE',
		'source_ip_address': '0.0.0.0',
		'slicer_api_url': 'https://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud:46233',
		'slicer_config': 'slicerID:basketball_slicer\nusername:[email protected]\napikey:*****\ninput:rtmp\nremote:on\ndescription:Sports\nautoexpire_age:3\nport:46230\nssl_port:46233\napi_port:46231\nmanual_ip:ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud\nrtmp_url:rtmp://0.0.0.0:46230/mss/47d3fdc1-86be-4cde-ac80-7019910d7a2f\n',
		'creation_time': 'Mar 15, 2022 9:37:00 PM',
		'slicer_domain_name': 'ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud',
		'slicer_ports': {
			'port': 46230,
			'apiPort': 46231,
			'sslPort': 46233
		},
		'slicer_stream_url': 'rtmp://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud/slicer46230',
		'slicer_stream_key': '47d3fdc1-86be-4cde-ac80-7019910d7a2f',
		'slicer_secure_stream_url': 'rtmps://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud:4935/slicer46230',
		'ingest_point_id': 'b20eb0a9-c9e2-469f-8f3b-c0b75051dcfb',
		'profile': '{"max_bframes": 3, "profile": "high", "aoKbps": null, "skipF": 0, "fps": 30, "vKbps": 2400, "aKbps": 128, "aMaxChannels": 2, "maxW": 1280, "isHD": false, "maxH": 720, "preset": "veryfast", "threads": 4, "vPasses": 2, "EncryptionKey": 2, "id": 4}',
		'isolation_required': False,
		'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
		'stream_type_id': ''
	},
	'meta': {
		'channel_id': '',
		'classification': '',
		'notes': '',
		'slicer_name': 'basketball_slicer'
	}
}