---
title: "VIA Orchestrate Status API — compact index for LLMs"
description: "Compact index for VOD orchestrate ingest status and cancellation."
---

<!-- /openapi/via-orchestrate-status-api.llms.md — generated from /openapi/via-orchestrate-status-api.yaml; do not edit by hand -->

# VIA Orchestrate Status API — compact index for LLMs

> Hub-maintained spec from `vod-orchestrator-status-api`. Pair with [feed ingest](/docs/feed-ingest/) to start ingests.

- **Per-tag slices:** `/openapi/via-orchestrate-status-api/tags/<slug>.openapi.yml`
- Canonical YAML: `/openapi/via-orchestrate-status-api.yaml`
- Scalar: `/reference/via-orchestrate-status-api/`
- Guide: [via-orchestrate-status-api](/docs/via-orchestrate-status-api/)

## API basics

- **Base URL:** `https://vod-ingest-status.{environment}.vmnd.tv`
- **Auth:** Bearer JWT — tenant resolved from the token by the API Gateway authorizer (no `X-Vimond-Tenant` header).
- **List:** `GET /ingests` — filter by `assetId`, `status`, `profileName`; paginate with `cursor` / `limit`; optional `fromDate` / `toDate`.
- **Detail:** `GET /ingests/{id}` — task-level history.
- **Cancel:** `DELETE /cancel/{id}` — stop a running ingest.

## Tags overview

| Tag | Operations | Per-tag slice | Description |
|-----|------------|---------------|-------------|
| Ingests | 2 | [`openapi/via-orchestrate-status-api/tags/ingests.openapi.yml`](/openapi/via-orchestrate-status-api/tags/ingests.openapi.yml) | List and fetch ingest job status. |
| Cancel | 1 | [`openapi/via-orchestrate-status-api/tags/cancel.openapi.yml`](/openapi/via-orchestrate-status-api/tags/cancel.openapi.yml) | Cancel a running ingest. |

## Operations

### Tag: Ingests (2)

**Per-tag slice:** [`/openapi/via-orchestrate-status-api/tags/ingests.openapi.yml`](/openapi/via-orchestrate-status-api/tags/ingests.openapi.yml) — self-contained OpenAPI for just this tag's operations and the schemas they reference.

List and fetch ingest job status.

#### GET /ingests — `listIngests`
**Tag:** Ingests • **Auth:** VimondAuth • **Responses:** 200, 401
query: assetId, status, profileName, fromDate, toDate, limit, cursor
**List ingest jobs**
Returns ingest summaries ordered by ingest timestamp (newest first). Filter by **`assetId`**, **`status`**, or **`profileName`** — only one filter applies per request (priority: `assetId`, then `status`, then `profileName`). Without…

#### GET /ingests/{id} — `getIngest`
**Tag:** Ingests • **Auth:** VimondAuth • **Responses:** 200, 401, 404
path: id
**Get ingest history by id**
Returns full ingest status including **`input`**, **`tasks`**, and per-task progress. Use the **`ingestId`** from list results or from the orchestrator workflow.

### Tag: Cancel (1)

**Per-tag slice:** [`/openapi/via-orchestrate-status-api/tags/cancel.openapi.yml`](/openapi/via-orchestrate-status-api/tags/cancel.openapi.yml) — self-contained OpenAPI for just this tag's operations and the schemas they reference.

Cancel a running ingest.

#### DELETE /cancel/{id} — `cancelIngest`
**Tag:** Cancel • **Auth:** VimondAuth • **Responses:** 204, 401, 404
path: id
**Cancel a running ingest**
Requests cancellation of an in-progress ingest.

---

_Generated from `/openapi/via-orchestrate-status-api.yaml` — 3 operations across 2 tags. Re-run `npm run openapi-derivatives` to refresh._