--- updatedAt: 2026-07-30T09:26:55.000Z agentTools: siteIndex: https://developer.bitmovin.com/llms.txt projectIndex: https://developer.bitmovin.com/encoding/llms.txt --- # List all Manifests # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "VOD Encoding API", "description": "Bitmovins API Reference Description", "version": "3.0", "termsOfService": "https://bitmovin.com", "contact": { "name": "Bitmovin Inc", "url": "https://bitmovin.com", "email": "support@bitmovin.com" } }, "servers": [ { "url": "https://api.bitmovin.com/v1", "description": "Bitmovin Server", "variables": {} } ], "security": [ { "ApiKeyAuth": [] }, { "ApiKeyAuth": [], "TenantOrgId": [] } ], "paths": { "/encoding/manifests": { "get": { "tags": [ "Manifests" ], "summary": "List all Manifests", "operationId": "GetEncodingManifests", "x-bitmovin": { "product": "shared" }, "parameters": [ { "name": "offset", "in": "query", "description": "Index of the first item to return, starting at 0. Default is 0", "style": "form", "schema": { "type": "integer", "example": 0 } }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. Default is 25, maximum is 100", "style": "form", "schema": { "type": "integer", "example": 25 } }, { "name": "sort", "in": "query", "description": "Order list result according to a filter resource attribute. The fields that can be used for sorting are: + `id` + `createdAt` + `modifiedAt` + `type` + `name`\n", "style": "form", "schema": { "type": "string", "example": "name:desc" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseEnvelope" }, { "properties": { "data": { "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "description": "All manifests with type information", "items": { "$ref": "#/components/schemas/Manifest" } } } } ] } } } } } ] } } } }, "default": { "description": "Error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "Your Bitmovin API key", "name": "X-Api-Key", "in": "header" }, "TenantOrgId": { "type": "apiKey", "description": "Your Bitmovin account organization", "name": "X-Tenant-Org-Id", "in": "header" } }, "schemas": { "BitmovinResource": { "title": "BitmovinResource", "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "name": { "type": "string", "description": "Name of the resource. Can be freely chosen by the user.", "example": "Name of the resource" }, "description": { "type": "string", "description": "Description of the resource. Can be freely chosen by the user.", "example": "Description of the resource" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "customData": { "type": "string", "writeOnly": true, "description": "User-specific meta data. This can hold anything.", "additionalProperties": { "type": "object" } } } } ] }, "BitmovinResponse": { "title": "BitmovinResponse", "required": [ "id" ], "properties": { "id": { "type": "string", "readOnly": true, "description": "Id of the resource", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } }, "AclEntry": { "title": "AclEntry", "required": [ "permission" ], "properties": { "scope": { "description": "Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all", "deprecated": true, "type": "string", "example": "public" }, "permission": { "description": "", "allOf": [ { "$ref": "#/components/schemas/AclPermission" } ] } } }, "AclPermission": { "title": "AclPermission", "type": "string", "enum": [ "PUBLIC_READ", "PRIVATE" ] }, "EncodingOutput": { "title": "EncodingOutput", "required": [ "outputId", "outputPath" ], "properties": { "outputId": { "type": "string", "description": "Id of the corresponding output", "example": "55354be6-0237-42bb-ae85-a2d4ef1ed19e" }, "outputPath": { "type": "string", "description": "Subdirectory where to save the files to", "example": "/encodings/movies/movie-1/video_720/" }, "acl": { "description": "Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL", "type": "array", "items": { "$ref": "#/components/schemas/AclEntry" } } } }, "Link": { "title": "Link", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "webpage target URL", "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period" }, "title": { "type": "string", "description": "Short description of the linked page", "example": "how to add a period to a manifest" } } }, "Manifest": { "title": "Manifest", "required": [ "outputs" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResource" }, { "properties": { "type": { "description": "", "allOf": [ { "$ref": "#/components/schemas/ManifestType" } ], "readOnly": true }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/EncodingOutput" }, "description": "The outputs to store the manifest" }, "status": { "description": "Current status", "allOf": [ { "$ref": "#/components/schemas/Status" } ], "readOnly": true } } } ] }, "ManifestType": { "title": "ManifestType", "type": "string", "enum": [ "DASH", "HLS", "SMOOTH_STREAMING" ], "example": "DASH", "x-enum-elements": [ { "name": "DASH", "description": "MPEG-DASH manifest" }, { "name": "HLS", "description": "Apple HTTP Live Streaming manifest" }, { "name": "SMOOTH_STREAMING", "description": "Microsoft Smooth Streaming manifest" } ] }, "Message": { "title": "Message", "required": [ "type", "text" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "type": { "description": "Message type giving a hint on the importance of the message (log level)", "allOf": [ { "$ref": "#/components/schemas/MessageType" } ] }, "text": { "type": "string", "description": "Message text", "example": "field must not be empty" }, "field": { "type": "string", "description": "Name of the field to which the message is referring to", "example": "manifestId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "more": { "type": "object", "description": "Service-specific information" }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the message occurred", "example": "2016-06-25T20:09:23.69Z" } } } ] }, "MessageType": { "title": "MessageType", "type": "string", "enum": [ "ERROR", "WARNING", "INFO", "DEBUG", "TRACE" ] }, "PaginationResponse": { "title": "PaginationResponse", "properties": { "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "offset": { "type": "integer", "format": "int32", "readOnly": true }, "limit": { "type": "integer", "format": "int32", "readOnly": true }, "previous": { "type": "string", "readOnly": true }, "next": { "type": "string", "readOnly": true }, "items": { "type": "array", "readOnly": true, "items": { "type": "object" } } } }, "ResponseEnvelope": { "title": "ResponseEnvelope", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "SUCCESS", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResultWrapper" } ] }, "more": { "type": "object", "description": "Additional endpoint specific information" } } }, "ResponseError": { "title": "ResponseError", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "ERROR", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResponseErrorData" } ] } } }, "ResponseErrorData": { "title": "ResponseErrorData", "required": [ "code", "message", "developerMessage" ], "properties": { "code": { "type": "integer", "format": "int32", "readOnly": true, "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n", "example": 1005 }, "message": { "type": "string", "readOnly": true, "description": "General error message" }, "developerMessage": { "type": "string", "readOnly": true, "description": "More detailed message meant for developers" }, "links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "details": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Message" }, "description": "collection of messages containing more detailed information on the cause of the error" } } }, "ResponseStatus": { "title": "ResponseStatus", "type": "string", "enum": [ "SUCCESS", "ERROR" ] }, "ResultWrapper": { "title": "ResultWrapper", "properties": { "result": { "type": "object", "readOnly": true } } }, "Status": { "title": "Status", "type": "string", "enum": [ "CREATED", "QUEUED", "RUNNING", "FINISHED", "ERROR", "CANCELED", "TRANSFER_ERROR" ], "example": "RUNNING", "x-enum-elements": [ { "name": "CREATED", "description": "The process has been created, but not started yet" }, { "name": "QUEUED", "description": "The process has been enqueued for execution and will start as soon as resources are available" }, { "name": "RUNNING", "description": "The process is being executed" }, { "name": "FINISHED", "description": "The process was finished successfully. This is a final state" }, { "name": "ERROR", "description": "The process has stopped due to an error. This is a final state" }, { "name": "CANCELED", "description": "The process has been canceled by the user. This is a final state" }, { "name": "TRANSFER_ERROR", "description": "The process has finished successfully, but at least one transfer to a configured output failed. The transfer attempt can be retried." } ] } } }, "tags": [ { "name": "Manifests" } ] } ```