Get All Ingest Points

Retrieves all ingest points.

Request

Request syntax:

GET /managed-slicer/slicers/ingest-points

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 ingest points.
total_items	Number	Indicates the total number of ingest points.

items List

The items list describes each ingest point through the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to a resource-specific endpoint.
@type	String	Returns IngestPoint.
created	String	Indicates the timestamp at which this ingest point was created.
desc	String	Indicates the ingest point's description.
endpoint_name	String	Indicates the ingest point's name.
id	String	Indicates the ingest point's system-defined ID.
ingest_point	Dictionary	Contains the ingest point's hostname and ports.
lastmod	String	Indicates the timestamp at which this ingest point was last modified.
server_region_id	String	Indicates the system-defined ID for the region assigned to the ingest point.
stream_type_id Deprecated	String	This property has been replaced by stream_type_name.
stream_type_name	String	Indicates the ingest point's protocol.

ingest_point Dictionary

The ingest_point dictionary describes an ingest point through the following properties:

Name	Data Type	Description
creation_time	String	Indicates the timestamp (UTC) at which the ingest point was created. Example: Jun 7, 2023 4:13:44 PM
ingest_point_id	String	Indicates the ingest point's system-defined ID.
reserved_domain_name	String	Indicates the ingest point's domain.
reserved_ports	Dictionary	Contains all of the ports associated with the ingest point.
secure_rtmp_url	String	RTMP Only Indicates the URL to which your encoder should push a RTMP feed. This URL uses the RTMP scheme.
server_region	String	Indicates the ingest point's region.
slicer_account_name	String	Reserved for future use.
status	String	Indicates whether a managed slicer has been associated with this ingest point. Valid values are: IN_USE	NOT_IN_USE
stream_rtmp_url	String	RTMPS Only Indicates the URL to which your encoder should push a RTMP feed. This URL, which uses the rtmps scheme, is secured using a TLS connection.

reserved_ports Dictionary

The reserved_ports dictionary describes an ingest point's ports through the following properties:

Name	Data Type	Description
port	Number	Indicates the ingest point's port.
port_fec2	Number	Indicates the ingest point's port for the row forward error correction (FEC) stream.
port_fec4	Number	Indicates the ingest point's port for the column forward error correction (FEC) stream.

Sample Request/Response

Call the get_all_ingest_points module (Python 3) to retrieve a list of ingest points. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        """
        Get all ingest points.
        """
        self._get_all_ingest_points()

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

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

        print(response.json())

IngestPoint().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers/ingest-points',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/managed-slicer/slicers/ingest_points/a3ff1ce5b63e4ea6aefb2963905edf97',
			'@type': 'IngestPoint',
			'id': 'a3ff1ce5b63e4ea6aefb2963905edf97',
			'created': '2022-03-03T18:20:39.034Z',
			'lastmod': '2022-03-03T18:20:39.034Z',
			'desc': 'ingest point 1',
			'ingest_point': {
				'ingest_point_id': '3682bebf-f37f-46e6-9456-707bb4abe2aa',
				'reserved_domain_name': 'ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud',
				'reserved_ports': {
					'port': 46240,
					'port_fec2': 46242,
					'port_fec4': 46244
				},
				'server_region': 'us-east-2',
				'slicer_account_name': 'MSS_4d3361ec890348a3bf4060464199ff05_4d3361ec890348a3bf4060464199ff05',
				'status': 'NOT_IN_USE',
				'creation_time': 'Mar 3, 2022 6:20:38 PM'
			},
			'stream_type_name': 'UDP',
			'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
			'stream_type_id': 'b348ad0563b44f85b48407e280499eda'
		}, {
			'@id': '/api/v4/managed-slicer/slicers/ingest_points/139e20ecf841417caa6e06572d95ca3f',
			'@type': 'IngestPoint',
			'created': '2022-03-04T23:14:28.062Z',
			'lastmod': '2022-03-04T23:14:28.062Z',
			'id': '139e20ecf841417caa6e06572d95ca3f',
			'desc': '',
			'ingest_point': {
				'ingest_point_id': '139e20ec-f841-417c-aa6e-06572d95ca3f',
				'reserved_domain_name': 'ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud',
				'reserved_ports': {
					'port': 46245,
					'port_fec2': 46247,
					'port_fec4': 46249
				},
				'server_region': 'us-east-2',
				'slicer_account_name': 'MSS_4d3361ec890348a3bf4060464199ff05_4d3361ec890348a3bf4060464199ff05',
				'status': 'NOT_IN_USE',
				'creation_time': 'Mar 4, 2022 11:14:27 PM'
			},
			'stream_type_name': 'UDP',
			'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
			'stream_type_id': 'b348ad0563b44f85b48407e280499eda'
		}, {
			'@id': '/api/v4/managed-slicer/slicers/ingest_points/9556928a1255488692239eac8f7f1ab7',
			'@type': 'IngestPoint',
			'created': '2022-03-04T23:15:26.083Z',
			'lastmod': '2022-03-04T23:15:26.083Z',
			'id': '9556928a1255488692239eac8f7f1ab7',
			'desc': 'ingest point 3',
			'ingest_point': {
				'ingest_point_id': '9556928a-1255-4886-9223-9eac8f7f1ab7',
				'reserved_domain_name': 'ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud',
				'reserved_ports': {
					'port': 46250,
					'port_fec2': 46252,
					'port_fec4': 46254
				},
				'server_region': 'us-east-2',
				'slicer_account_name': 'MSS_4d3361ec890348a3bf4060464199ff05_4d3361ec890348a3bf4060464199ff05',
				'status': 'NOT_IN_USE',
				'creation_time': 'Mar 4, 2022 11:15:25 PM'
			},
			'stream_type_name': 'UDP',
			'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
			'stream_type_id': 'b348ad0563b44f85b48407e280499eda'
		}
	],
	'total_items': 3
}