Update Ingest Point

Updates an ingest point's name or description.

Request

Request syntax:

PATCH /managed-slicer/slicers/ingest-points/Ingest Point ID

Request URL variable:

Define the following variable when submitting the above request:

Request body parameters:

Pass the following request body parameters:

Response

The response for a successful request contains the following properties:

ingest_point Dictionary

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

reserved_ports Dictionary

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

Sample Request/Response

Call the update_ingest_point module (Python 3) to update an ingest point. This module imports names from the api_auth module.

import json, requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._update_ingest_point()

    def _update_ingest_point(self):
        ingest_point_id = 'f0a214a437024a9c85c59f6f1bd55b3e'  # Replace with the desired ingest point ID.
        url = "{}{}{}".format(self.host, "/api/v4/managed-slicer/slicers/ingest-points/", ingest_point_id)

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

        payload = {
            'desc': 'Basketball - East Coast Ingest' # Replace with the desired description.
        }

        response = requests.patch(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

IngestPoint().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers/ingest-points/f0a214a437024a9c85c59f6f1bd55b3e',
	'@type': 'IngestPoint',
	'id': 'f0a214a437024a9c85c59f6f1bd55b3e',
	'created': '2022-03-04T23:28:20.255Z',
	'lastmod': '2022-03-04T23:28:20.255Z',
	'desc': 'Basketball - East Coast Ingest',
	'ingest_point': {
		'ingest_point_id': 'f0a214a4-3702-4a9c-85c5-9f6f1bd55b3e',
		'reserved_domain_name': 'ingest-stage-1-us-east-2.mss-develop.aws.oath.cloud',
		'reserved_ports': {
			'port': 46255,
			'port_fec2': 46257,
			'port_fec4': 46259
		},
		'server_region': 'us-east-2',
		'status': 'NOT_IN_USE'
	},
	'stream_type_name': 'UDP',
	'server_region_id': '4ae28f7a33c44473861b40d1c7e3072e',
	'stream_type_id': 'b348ad0563b44f85b48407e280499eda'
}