Skip to content
Vimond Vimond Vimond Developer Hub

VIA Orchestrate Status API

Ingest Status

Section titled “Ingest Status”

An ingest job is the process of introducing a video file to the orchestrate pipeline. The status API is used to monitor the history of each of these ingest jobs and are displayed in the monitoring UI.

A typical ingest job has the following steps and for each of the steps in the pipeline, the status is updated and will be available from the status API.

The status items are ordered in ingest timestamp from latest to oldest.

Also, adding ingestId to the query will fetch the detailed status for the specific ingest.

It is also possible to cancel a running ingest with the cancel endpoint using the ingestId.

Status API has three endpoints:

Lists all ingests:

Section titled “Lists all ingests:”

The ingests endpoint allows us to view and monitor the status of all ingests. It is also possible to filter the result by assetId, ingestId, profile name and status.
In addition, the user can limit the number of results retrieved as well.

curl --request GET \
  --url https://vod-ingest-status.eu-north-1-prod.vmnd.tv/ingests \
  --header 'Authorization: Bearer <insert token here>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vimond-Tenant: vimond'

As a result, a list of items will be returned as a response.

{
  "items": [
    {
      "ingestId": "ff0dac68-5cdd-4d9b-9fc8-915668a9df8c",
      "assetId": "869214",
      "detailsUrl": "/ingests/ff0dac68-5cdd-4d9b-9fc8-915668a9df8c",
      "profileName": "331456700",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T10:50:21.481Z",
      "endTime": "2021-12-08T10:50:44.166Z",
      "status": "COMPLETED",
      "elapsedTime": 22685
    },
    {
      "ingestId": "78890bcc-5c49-46a6-9b70-8ff7f3ca1b5a",
      "assetId": "869216",
      "detailsUrl": "/ingests/78890bcc-5c49-46a6-9b70-8ff7f3ca1b5a",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T10:50:20.577Z",
      "endTime": "2021-12-08T10:51:02.951Z",
      "status": "SKIPPED",
      "elapsedTime": 42374
    },
    {
      "ingestId": "c0f04fc1-17a3-45e4-a922-c26e3023de33",
      "assetId": "869217",
      "detailsUrl": "/ingests/c0f04fc1-17a3-45e4-a922-c26e3023de33",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 0,
      "startTime": "2021-12-08T10:50:20.422Z",
      "endTime": "2021-12-08T10:50:26.354Z",
      "status": "SKIPPED",
      "elapsedTime": 5932
    },
    {
      "ingestId": "9e81a676-5b0c-462c-a2ae-a1ed20b6b642",
      "assetId": "869213",
      "detailsUrl": "/ingests/9e81a676-5b0c-462c-a2ae-a1ed20b6b642",
      "profileName": "810328014",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T10:50:20.137Z",
      "endTime": "2021-12-08T10:50:43.986Z",
      "status": "COMPLETED",
      "elapsedTime": 23849
    },
    {
      "ingestId": "694e6d12-e63b-4141-b177-57166c4c4238",
      "assetId": "869215",
      "detailsUrl": "/ingests/694e6d12-e63b-4141-b177-57166c4c4238",
      "profileName": "1089343830",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T10:50:19.054Z",
      "endTime": "2021-12-08T10:51:04.767Z",
      "status": "COMPLETED",
      "elapsedTime": 45713
    },
    {
      "ingestId": "05c42317-1c5d-4c40-a3b7-a047283c6a7a",
      "assetId": "869205",
      "detailsUrl": "/ingests/05c42317-1c5d-4c40-a3b7-a047283c6a7a",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 0,
      "startTime": "2021-12-08T09:50:23.477Z",
      "endTime": "2021-12-08T09:50:28.969Z",
      "status": "SKIPPED",
      "elapsedTime": 5492
    },
    {
      "ingestId": "2ce4a3c3-0d00-4f6d-9ae7-616d6fb7b50d",
      "assetId": "869206",
      "detailsUrl": "/ingests/2ce4a3c3-0d00-4f6d-9ae7-616d6fb7b50d",
      "profileName": "810328014",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T09:50:22.913Z",
      "endTime": "2021-12-08T09:50:47.798Z",
      "status": "COMPLETED",
      "elapsedTime": 24885
    },
    {
      "ingestId": "0d898abf-acd9-4cf4-8abc-e142e114fc66",
      "assetId": "869208",
      "detailsUrl": "/ingests/0d898abf-acd9-4cf4-8abc-e142e114fc66",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T09:50:22.793Z",
      "endTime": "2021-12-08T09:51:08.767Z",
      "status": "SKIPPED",
      "elapsedTime": 45974
    },
    {
      "ingestId": "63fb614c-cb6f-4f6b-9760-bb59df7b88c6",
      "assetId": "869209",
      "detailsUrl": "/ingests/63fb614c-cb6f-4f6b-9760-bb59df7b88c6",
      "profileName": "331456700",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T09:50:22.489Z",
      "endTime": "2021-12-08T09:50:47.772Z",
      "status": "COMPLETED",
      "elapsedTime": 25283
    },
    {
      "ingestId": "f52c2f41-c60f-4f36-99a6-21252891c32b",
      "assetId": "869207",
      "detailsUrl": "/ingests/f52c2f41-c60f-4f36-99a6-21252891c32b",
      "profileName": "1089343830",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T09:50:21.128Z",
      "endTime": "2021-12-08T09:51:10.695Z",
      "status": "COMPLETED",
      "elapsedTime": 49567
    },
    {
      "ingestId": "0677328c-b34d-4a8c-a3d8-884c3de26493",
      "assetId": "869200",
      "detailsUrl": "/ingests/0677328c-b34d-4a8c-a3d8-884c3de26493",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 0,
      "startTime": "2021-12-08T08:50:13.221Z",
      "endTime": "2021-12-08T08:50:19.197Z",
      "status": "SKIPPED",
      "elapsedTime": 5976
    },
    {
      "ingestId": "786a1743-9209-4cce-a7d1-0d1016ef0485",
      "assetId": "869203",
      "detailsUrl": "/ingests/786a1743-9209-4cce-a7d1-0d1016ef0485",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T08:50:12.604Z",
      "endTime": "2021-12-08T08:50:58.255Z",
      "status": "SKIPPED",
      "elapsedTime": 45651
    },
    {
      "ingestId": "5fc72f76-82c4-4da8-a883-0504cd0a1492",
      "assetId": "869202",
      "detailsUrl": "/ingests/5fc72f76-82c4-4da8-a883-0504cd0a1492",
      "profileName": "331456700",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T08:50:12.389Z",
      "endTime": "2021-12-08T08:50:35.634Z",
      "status": "COMPLETED",
      "elapsedTime": 23245
    },
    {
      "ingestId": "ce5f6747-da67-48fe-8f3b-09cf73dc16be",
      "assetId": "869201",
      "detailsUrl": "/ingests/ce5f6747-da67-48fe-8f3b-09cf73dc16be",
      "profileName": "810328014",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T08:50:12.064Z",
      "endTime": "2021-12-08T08:50:35.450Z",
      "status": "COMPLETED",
      "elapsedTime": 23386
    },
    {
      "ingestId": "2669a618-cc0b-49f2-85c7-321af179311f",
      "assetId": "869204",
      "detailsUrl": "/ingests/2669a618-cc0b-49f2-85c7-321af179311f",
      "profileName": "1089343830",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T08:50:10.812Z",
      "endTime": "2021-12-08T08:50:59.775Z",
      "status": "COMPLETED",
      "elapsedTime": 48963
    },
    {
      "ingestId": "3c28fb51-4303-4966-ab48-5eadbb51bb5b",
      "assetId": "869193",
      "detailsUrl": "/ingests/3c28fb51-4303-4966-ab48-5eadbb51bb5b",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 0,
      "startTime": "2021-12-08T07:50:15.527Z",
      "endTime": "2021-12-08T07:50:21.651Z",
      "status": "SKIPPED",
      "elapsedTime": 6124
    },
    {
      "ingestId": "2f72ad05-929b-4a29-a4dd-260ca6e21bb4",
      "assetId": "869196",
      "detailsUrl": "/ingests/2f72ad05-929b-4a29-a4dd-260ca6e21bb4",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T07:50:15.486Z",
      "endTime": "2021-12-08T07:50:56.312Z",
      "status": "SKIPPED",
      "elapsedTime": 40826
    },
    {
      "ingestId": "aa7be290-335b-406b-b660-1da2a14dca2f",
      "assetId": "869194",
      "detailsUrl": "/ingests/aa7be290-335b-406b-b660-1da2a14dca2f",
      "profileName": "331456700",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T07:50:15.058Z",
      "endTime": "2021-12-08T07:50:37.653Z",
      "status": "COMPLETED",
      "elapsedTime": 22595
    },
    {
      "ingestId": "1f5dd9f7-be75-48af-99d0-e36d40297025",
      "assetId": "869195",
      "detailsUrl": "/ingests/1f5dd9f7-be75-48af-99d0-e36d40297025",
      "profileName": "810328014",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T07:50:14.640Z",
      "endTime": "2021-12-08T07:50:37.391Z",
      "status": "COMPLETED",
      "elapsedTime": 22751
    },
    {
      "ingestId": "66aa4946-fad9-4cb3-829e-66f66ed3b293",
      "assetId": "869197",
      "detailsUrl": "/ingests/66aa4946-fad9-4cb3-829e-66f66ed3b293",
      "profileName": "1089343830",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T07:50:13.318Z",
      "endTime": "2021-12-08T07:50:58.273Z",
      "status": "COMPLETED",
      "elapsedTime": 44955
    },
    {
      "ingestId": "80f59834-f9bc-4cf0-980a-e02c230f7f9a",
      "assetId": "869190",
      "detailsUrl": "/ingests/80f59834-f9bc-4cf0-980a-e02c230f7f9a",
      "profileName": "331456700",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T06:50:14.893Z",
      "endTime": "2021-12-08T06:50:34.112Z",
      "status": "COMPLETED",
      "elapsedTime": 19219
    },
    {
      "ingestId": "1eb0d8da-a3a5-4ca2-ac01-294fadf81d84",
      "assetId": "869189",
      "detailsUrl": "/ingests/1eb0d8da-a3a5-4ca2-ac01-294fadf81d84",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T06:50:14.464Z",
      "endTime": "2021-12-08T06:50:55.361Z",
      "status": "SKIPPED",
      "elapsedTime": 40897
    },
    {
      "ingestId": "aa398230-6851-404d-9b6d-976c42a17b93",
      "assetId": "869187",
      "detailsUrl": "/ingests/aa398230-6851-404d-9b6d-976c42a17b93",
      "profileName": "1292397813",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 0,
      "startTime": "2021-12-08T06:50:13.922Z",
      "endTime": "2021-12-08T06:50:20.041Z",
      "status": "SKIPPED",
      "elapsedTime": 6119
    },
    {
      "ingestId": "dea20cab-d3a1-49db-bc41-e1136e842496",
      "assetId": "869191",
      "detailsUrl": "/ingests/dea20cab-d3a1-49db-bc41-e1136e842496",
      "profileName": "810328014",
      "error": null,
      "mediaTypes": [
        "SMIL"
      ],
      "progress": 100,
      "startTime": "2021-12-08T06:50:13.576Z",
      "endTime": "2021-12-08T06:50:35.135Z",
      "status": "COMPLETED",
      "elapsedTime": 21559
    },
    {
      "ingestId": "599fe93c-7ed1-4484-98ee-5a189c7bb25e",
      "assetId": "869188",
      "detailsUrl": "/ingests/599fe93c-7ed1-4484-98ee-5a189c7bb25e",
      "profileName": "1089343830",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 20,
      "startTime": "2021-12-08T06:50:12.412Z",
      "endTime": "2021-12-08T06:50:57.152Z",
      "status": "COMPLETED",
      "elapsedTime": 44740
    }
  ],
  "count": 25,
  "cursor": "eyJzdGFydFRpbWUiOiIyMDIxLTEyLTA4VDA2OjUwOjEyLjQxMloiLCJpbmdlc3RJZCI6IjU5OWZlOTNjLTdlZDEtNDQ4NC05OGVlLTVhMTg5YzdiYjI1ZSJ9"
}

API Reference for listing all ingests

Fetch ingests for a single asset

Section titled “Fetch ingests for a single asset”

The API can be used for getting all the ingests executed for a given asset. The response will be a list of ingests with general information about each ingest (start time, end time, status, media types etc). A detailsUrl link can be followed to provide the details for each ingest.

curl --request GET \
  --url https://vod-ingest-status.eu-north-1-prod.vmnd.tv/ingests?assetId=179057 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vimond-Tenant: vimond'
{
  "items": [
    {
      "ingestId": "d484cf3e-a329-438a-9896-b55e026f62c4",
      "assetId": "179057",
      "detailsUrl": "/ingests/d484cf3e-a329-438a-9896-b55e026f62c4",
      "profileName": "2785383677",
      "error": null,
      "mediaTypes": [
        "VIDEO"
      ],
      "progress": 100,
      "startTime": "2022-07-21T13:03:33.945Z",
      "endTime": "2022-07-21T13:04:44.644Z",
      "status": "COMPLETED",
      "elapsedTime": 70699
    }
  ],
  "count": 1,
  "cursor": null
}

Fetch a single ingest history by ingestId

Section titled “Fetch a single ingest history by ingestId”

To filter out the status of a single ingest, the ingest id can be added to the query. For example,

curl --request GET \
  --url https://vod-ingest-status.eu-north-1-prod.vmnd.tv/ingests/7dd40659-2494-45bc-b533-83e7deb97155 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vimond-Tenant: vimond'

This will fetch the status of a single ingest.

{
  "status": "SKIPPED",
  "startTime": "2021-11-03T07:50:32.899Z",
  "endTime": "2021-11-03T07:51:16.447Z",
  "progress": 20,
  "elapsedTime": 43548,
  "assetId": "867228",
  "ingestId": "7dd40659-2494-45bc-b533-83e7deb97155",
  "tenant": "vimond",
  "profileName": "1292397813",
  "input": {
    "filesets": [
      {
        "files": [
          {
            "mediaType": "VIDEO",
            "language": null,
            "uri": "https://video-ingest-test-public.s3.eu-central-1.amazonaws.com/clip-3253000.mp4",
            "md5sum": null
          }
        ],
        "labels": [
          "initialInput"
        ]
      }
    ],
    "profile": {
      "name": "1292397813",
      "details": {
        "profileName": "1292397813",
        "profileVersionId": 1619086864969,
        "packaging": [],
        "encoding": [
          {
            "filesetFilter": "retrieved",
            "encodingProfile": {
              "versionId": 1619088689972,
              "iamRoleArn": "arn:aws:iam::786994645791:role/eu-north-1-dev-video-vimond_mediaconvert",
              "name": "993387234",
              "sourceLocation": {
                "name": "2360609790",
                "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-source",
                "versionId": 1619090434714,
                "type": "s3"
              },
              "jobTemplateName": "dev-nodrm-default",
              "type": "AWS_MEDIA_CONVERT",
              "targetLocation": {
                "name": "2376209780",
                "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-output",
                "versionId": 1619090458439,
                "type": "s3"
              },
              "region": "eu-north-1",
              "mediaConvertEndpointUrl": "https://xnlmxec5a.mediaconvert.eu-north-1.amazonaws.com"
            },
            "filesetLabelOut": "encoded"
          }
        ],
        "distribution": [
          {
            "filesetFilter": "encoded",
            "filesetLabelOut": "distributed",
            "distributionProfile": {
              "name": "1135016737",
              "versionId": 1619087138773,
              "sourceLocation": {
                "name": "2376209780",
                "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-output",
                "versionId": 1619090458439,
                "type": "s3"
              },
              "type": "URL_REWRITE",
              "targetLocation": {
                "name": "570015501",
                "versionId": 1619520880352,
                "baseUrl": "https://vimond.video-output.eu-north-1-dev.vmnd.tv",
                "type": "web"
              }
            }
          }
        ],
        "playout": [
          {
            "filesetFilter": "distributed AND HLS",
            "playoutProfile": {
              "name": "2954255440",
              "versionId": 1619092739985,
              "vimondRestAPIPlaybackSettings": {
                "format": "HLS"
              },
              "type": "VIMOND_REST_API_PLAYBACK",
              "targetLocation": {
                "name": "921214079",
                "versionId": 1619089889119,
                "hostname": "vimond.rest-api.eu-north-1-dev.vmnd.tv",
                "auth0M2MSettingsParameterStoreKey": "/video/eu-north-1-dev-video/tenants/vimond/playout/auth0M2M",
                "type": "vimondrestapi"
              }
            },
            "filesetLabelOut": null
          },
          {
            "filesetFilter": "distributed AND DASH",
            "playoutProfile": {
              "name": "1778219957",
              "versionId": 1619092673056,
              "vimondRestAPIPlaybackSettings": {
                "format": "DASH"
              },
              "type": "VIMOND_REST_API_PLAYBACK",
              "targetLocation": {
                "name": "921214079",
                "versionId": 1619089889119,
                "hostname": "vimond.rest-api.eu-north-1-dev.vmnd.tv",
                "auth0M2MSettingsParameterStoreKey": "/video/eu-north-1-dev-video/tenants/vimond/playout/auth0M2M",
                "type": "vimondrestapi"
              }
            },
            "filesetLabelOut": null
          }
        ],
        "pipelineVersion": "0.1.5",
        "executionId": "7dd40659-2494-45bc-b533-83e7deb97155",
        "assetId": 867228,
        "retrieval": [
          {
            "filesetFilter": "initialInput",
            "retrievalProfile": {
              "name": "3781011464",
              "versionId": 1619096301456,
              "type": "vimond_file_retriever",
              "targetLocation": {
                "name": "2360609790",
                "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-source",
                "versionId": 1619090434714,
                "type": "s3"
              },
              "skipOnMD5": true
            },
            "filesetLabelOut": "retrieved"
          }
        ],
        "subtitlePublishing": [],
        "filesets": [
          {
            "files": [
              {
                "mediaType": "VIDEO",
                "language": null,
                "uri": "https://video-ingest-test-public.s3.eu-central-1.amazonaws.com/clip-3253000.mp4",
                "md5sum": null
              }
            ],
            "labels": [
              "initialInput"
            ]
          }
        ],
        "tenant": "vimond"
      },
      "id": 1619086864969
    }
  },
  "mediaTypes": [
    "VIDEO"
  ],
  "tasks": [
    {
      "outputs": {
        "filesets": [
          {
            "files": [
              {
                "mediaType": "VIDEO",
                "language": null,
                "uri": "s3://eu-north-1-dev-video-vimond-mc-source/clip-3253000_362028.mp4",
                "md5sum": null
              }
            ],
            "location": {
              "name": "2360609790",
              "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-source",
              "versionId": 1619090434714,
              "type": "s3"
            },
            "labels": [
              "retrieved",
              "skippedUpload"
            ]
          }
        ]
      },
      "input": {
        "filesets": [
          {
            "files": [
              {
                "mediaType": "VIDEO",
                "language": null,
                "uri": "https://video-ingest-test-public.s3.eu-central-1.amazonaws.com/clip-3253000.mp4",
                "md5sum": null
              }
            ],
            "labels": [
              "initialInput"
            ]
          }
        ],
        "profile": {
          "name": "3781011464",
          "versionId": 1619096301456,
          "type": "vimond_file_retriever",
          "targetLocation": {
            "name": "2360609790",
            "s3Arn": "arn:aws:s3:::eu-north-1-dev-video-vimond-mc-source",
            "versionId": 1619090434714,
            "type": "s3"
          },
          "skipOnMD5": true
        }
      },
      "name": "RETRIEVAL",
      "progress": 100,
      "startTime": "2021-11-03T07:50:35.328Z",
      "endTime": "2021-11-03T07:51:14.124Z",
      "id": "f1db16c3-ee45-44c8-a94e-ed99c0a685b1",
      "status": "TASK_COMPLETED",
      "elapsedTime": 38796
    }
  ],
  "error": null
}

API Reference for fetching history of a single ingest

Cancel a running ingest

Section titled “Cancel a running ingest”

It is also possible to cancel a running ingest using the /cancel/{id} endpoint.

curl --request DELETE \
  --url https://vod-ingest-status.eu-north-1-prod.vmnd.tv/cancel/7dd40659-2494-45bc-b533-83e7deb97155 \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjFvWDYwWDRtZXA0ZWZON0Mwb3dwOCJ9.eyJodHRwczovL3ZpbW9uZC9lbWFpbCI6ImRpdnlhQHZpbW9uZC5jb20iLCJodHRwczovL3ZpbW9uZC9jbGllbnRJRCI6ImpVZUN1cnd2WTExMlN0SXA1bEwxcG9HcGpKU1pucmQzIiwiaHR0cHM6Ly92aW1vbmQvcm9sZXMiOlsiYWRtaW4iLCJ2YmMiXSwiaHR0cHM6Ly92aW1vbmQvcGVybWlzc2lvbnMiOltdLCJodHRwczovL3ZpbW9uZC9maXJzdE5hbWUiOiJEaXZ5YSIsImh0dHBzOi8vdmltb25kL2xhc3ROYW1lIjoiU2FybWEiLCJpc3MiOiJodHRwczovL3ZpbW9uZC1kZXYtbmV4dC12Y2Mudmltb25kLWRldi5hdXRoMC5jb20vIiwic3ViIjoiYXV0aDB8YXV0aDB8NjE0ZDk4Yjg3OTc3ODg2ODhiNmVkNmU5IiwiYXVkIjpbImh0dHBzOi8vdmltb25kLWRldi1uZXh0LXZjYy52aW1vbmQtZGV2LnZjYy5jb20vIiwiaHR0cHM6Ly92aW1vbmQtZGV2LW5leHQtdmNjLnZpbW9uZC1kZXYuYXV0aDAuY29tL3VzZXJpbmZvIl0sImlhdCI6MTYzODk2MjA3NywiZXhwIjoxNjM4OTY5Mjc3LCJhenAiOiJqVWVDdXJ3dlkxMTJTdElwNWxMMXBvR3BqSlNabnJkMyIsInNjb3BlIjoib3BlbmlkIn0.SasPvR1wGhpNn1U1IzWl9CMTGGizM26TjTJQaMedjxa2fTLS21jwkoae0ub1HNNkALlKCyfJxU4pgrCo9CuF0AJWKopU1nuPf-xILfYZfV6u5Hin6TS95OUbJMyYfHr4GZUYbyNzasNPQ8S4rMdsGdB5IJPC9BgbTj-xbiE7y9p8Wr1vbr_vJjhVX5gPzpSNsCoe6db4mMtRFSjWa8cd-nQBRM-rpXevtkjOwUM_GZU0tozMiBTUVBisv_Nv_ar8nrmhKRY5TeDv-SESW_5MDD39t5JLgZey_E1CvArGqGT6HcIcsD3tdRr6Vjy0AOV80g3l-vuIIRNFV0N9lNsLbQ' \
  --header 'Content-Type: application/json'

This will return a response code 204 with no content.

API Reference for cancelling an ingest in progress

Response Parameters

Section titled “Response Parameters”

Please find the description and examples for some response parameters below:

ParameterDescriptionExample
ingestIdUnique identifier for an ingest”ff0dac68-5cdd-4d9b-9fc8-915668a9df8c”
assetIdUnique identifier for an asset”869214”
detailsUrlURL details for the specific ingest”/ingests/ff0dac68-5cdd-4d9b-9fc8-915668a9df8c”
profileNameProfile used for the specific ingest”331456700”
errorError details if there are anynull
mediaTypesType of the file ingested[ “VIDEO” ]
progressPercentage of progress100
startTimeStart time for the ingest job”2021-12-08T10:50:21.481Z”
endTimeEnd time for the ingest job”2021-12-08T10:50:44.166Z”
statusStatus of the ingest”COMPLETED”
elapsedTimeTime elapsed for the ingest22685
tenantTenant details of the user”vimond”
inputDetails of the input such as no.of files, filenames, uri etc
tasksSpecific details of each tasks in the pipeline such as retrieval, encoding etc