Delete Ingest Point

Deletes an ingest point.

Request

Request syntax:

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

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
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.

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 IngestPoint.
task	Dictionary	Contains information that describes the task associated with this request to delete an ingest point.

task Dictionary

The task dictionary describes a request to delete an ingest point through the following properties:

Name	Data Type	Description
id	String	Indicates the system-defined ID assigned to the task.
state	String	Indicates the task's state. Returns COMPLETED when the ingest point has been successfully deleted.
operation	String	Returns DELETE.

Sample Request/Response

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

import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        self._delete_ingest_point()

    def _delete_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'}

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

        print(response.json())

IngestPoint().run()

Response:

{
	'@id': '/api/v4/managed-slicer/slicers/ingest-points/f0a214a437024a9c85c59f6f1bd55b3e',
	'@type': 'IngestPoint',
	'task': {
		'id': 'b5c335c4-64f6-44c0-baa5-a184746477bf',
		'state': 'COMPLETED',
		'operation': 'DELETE'
	}
}