Get All CSL

Get All CSL Slicers

Retrieves a list of CSL slicers.

Request

Request syntax:

GET /managed-slicer/slicers

Response

The response for a successful request contains the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to this endpoint.
@type	String	Returns Collection.
items	List of Dictionaries	Contains a list of your CSL slicers.
total_items	Number	Indicates the total number of CSL slicers.

items List

The items list describes each CSL slicer through the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path that returns this resource.
@type	String	Returns ManagedSlicer.
id	String	Indicates the CSL slicer's system-defined ID.
created	String	Indicates the timestamp at which the CSL slicer was created.
lastmod	String	Indicates the timestamp at which the CSL slicer was last modified.
profile	String	Describes the encoding profile assigned to the CSL slicer.
slicer_id	String	Indicates the CSL slicer's Slicer ID.
status	String	Indicates the CSL slicer's status. Learn more.
stream_type_id	String	Indicates the system-defined ID for the CSL slicer's protocol.
slicer_stream_key	String	Reserved for future use.
slicer_stream_url	String	Indicates the URL to which you may push your feed. This CSL slicer will ingest the content that is pushed to this URL.
slicer_secure_stream_url	String	RTMP Only Indicates a secure URL to which you may push your feed. This CSL slicer will ingest the content that is pushed to this URL.
slicer_software_version	String	Reserved for future use.
slicer_version	String	Indicates a slicer version by its system-defined ID. This CSL slicer runs on this slicer version.
channel_id	String	Indicates a live channel by its system-defined ID.
classification	String	Reserved for future use.
notes	String	Indicates the notes associated with this CSL slicer.
slicer_name	String	Indicates the CSL slicer's name.

Sample Request/Response

Call the get_all_csl_slicers module (Python 3) to retrieve a list of CSL slicers. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        """
        Get all CSL slicers.
        """
        self._get_all_csl_slicers()

    def _get_all_csl_slicers(self):
        url = "{}{}".format(self.host, "/api/v4/managed-slicer/slicers")

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

        print(response.json())

CSLSlicers().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/managed-slicer/slicers/fb35725e43454d4d9bd6d67b355ed690',
			'@type': 'ManagedSlicer',
			'id': 'fb35725e43454d4d9bd6d67b355ed690',
			'created': '2022-03-10T17:11:28.403Z',
			'lastmod': '2022-03-10T17:11:44.925Z',
			'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}',
			'slicer_id': 'devtest1',
			'status': 'COMPLETED',
			'stream_type_id': 'b348ad0563b44f85b48407e280499eda',
			'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
			'slicer_stream_key': None,
			'slicer_stream_url': 'rtmp://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud:46245',
			'slicer_secure_stream_url': None,
			'slicer_software_version': None,
			'slicer_version': 'STABLE',
			'channel_id': '',
			'classification': 'prod',
			'notes': '',
			'slicer_name': 'devtest1'
		}, {
			'@id': '/api/v4/managed-slicer/slicers/2803da54cb8e47668f36908bef564fee',
			'@type': 'ManagedSlicer',
			'id': '2803da54cb8e47668f36908bef564fee',
			'created': '2022-03-15T17:03:40.314Z',
			'lastmod': '2022-03-15T17:49:36.221Z',
			'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}',
			'slicer_id': 'basketball_slicer',
			'status': 'COMPLETED',
			'stream_type_id': '',
			'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
			'slicer_stream_key': '6c03c9bd-78d7-4a93-aebb-74802392fdad',
			'slicer_stream_url': 'rtmp://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud/slicer46210',
			'slicer_secure_stream_url': 'rtmps://ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud:4935/slicer46210',
			'slicer_software_version': None,
			'slicer_version': 'STABLE',
			'channel_id': '',
			'classification': '',
			'notes': '',
			'slicer_name': 'basketball_slicer'
		}
	],
	'total_items': 2
}