Get CSL Versions

Retrieves a list of the available slicer versions for a specific region.

All regions typically support the same set of slicer versions. However, you must specify a region-specific slicer version when setting up a CSL slicer.

Request

Request syntax:

GET /managed-slicer/slicers/version/Region

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
Region ID RequiredReplace this variable with the system-defined ID assigned to the desired region. Use the Get CSL Slicer Regions endpoint to retrieve a list of regions and their system-defined IDs.

Authentication

Pass a digital signature based off of msg.

Learn more.

Response

The response for a successful request contains the following properties:

NameData TypeDescription
@idStringIndicates the relative path to this endpoint.
@typeStringReturns Collection.
itemsList of dictionariesContains a list of slicer versions for the specified region.
total_itemsStringIndicates the total number of slicer versions for the specified region.
NameData TypeDescription
@idStringReserved for future use.
@typeStringReserved for future use.
version_idStringIndicates the system-defined ID assigned to the slicer version.
slicer_versionStringIndicates the slicer version number.
descriptionStringIndicates the slicer version's description.
creation_timeStringIndicates the timestamp at which the slicer version was added to this region.

Sample Request/Response

Call the get_csl_slicer_versions module (Python 3) to retrieve the available slicer versions for a specific region. This module imports names from the api_auth module.

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._get_csl_slicer_versions()

    def _get_csl_slicer_versions(self):
        region_id = 'a7548f530d4347a7a627499ea71e1726'  # Replace with the desired region ID.
        url = "{}{}{}".format(self.host, "/api/v4/managed-slicer/slicers/versions/", region_id)

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

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

        print(response.json())

CSLSlicerVersion().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers/versions/a7548f530d4347a7a627499ea71e1726',
	'@type': 'Collection',
	'items': [{
			'version_id': '0.8.21081100',
			'slicer_version': '21081100',
			'description': 'Latest version generated from slicer version 21081100',
			'creation_time': 'Oct 18, 2021 11:57:10 AM'
		}, {
			'version_id': '0.10.22060200',
			'slicer_version': '22060200',
			'description': 'Latest version generated from slicer version 22060200',
			'creation_time': 'Jun 6, 2022 8:47:01 AM'
		}, {
			'version_id': 'LATEST',
			'slicer_version': '22060200',
			'description': 'Slicer with TS TCP support Master',
			'creation_time': 'Jun 6, 2022 8:47:01 AM'
		}, {
			'version_id': '0.6.20122400',
			'slicer_version': '20122400',
			'description': 'Latest version generated from slicer version 20122400',
			'creation_time': 'Jun 9, 2021 2:02:36 PM'
		}, {
			'version_id': '0.7.20122400',
			'slicer_version': '20122400',
			'description': 'Latest version generated from slicer version 20122400',
			'creation_time': 'Jun 10, 2021 9:38:49 AM'
		}, {
			'version_id': '0.9.22022301',
			'slicer_version': '22022301',
			'description': 'Latest version generated from slicer version 22022301',
			'creation_time': 'Mar 10, 2022 4:51:20 PM'
		}, {
			'version_id': '0.6.20081700',
			'slicer_version': '20081700',
			'description': 'Latest version generated from slicer version 20081700',
			'creation_time': 'Jan 31, 2021 8:50:40 AM'
		}, {
			'version_id': '0.7.21061800',
			'slicer_version': '21061800',
			'description': 'Latest version generated from slicer version 21061800',
			'creation_time': 'Aug 6, 2021 9:50:28 PM'
		}, {
			'version_id': 'STABLE',
			'slicer_version': '21061800',
			'description': 'Updated stable to 21061800 for hwenc support',
			'creation_time': 'Jul 7, 2021 1:49:10 PM'
		}
	],
	'total_items': 9
}