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:

Variable	Description
Ingest Point ID Required	Replace this variable with the system-defined ID assigned to the desired ingest point. Use the Get All Ingest Points endpoint to retrieve a list of ingest points and their system-defined IDs.

Request body parameters:

Pass the following request body parameters:

Name	Data Type	Description
desc	String	Sets the ingest point's description.
endpoint_name	String	Sets the ingest point's name.

Response

The response for a successful request contains 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

The code below (Python 3) shows how to update an ingest point.

This code imports names from the api_auth module for V4 APIs (see below).

🦉

API Auth for Classic Authentication (V4 APIs)

Open Recipe

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"
}