openapi: 3.0.1 info: title: Bitmovin Encoding API description: REST API for cloud-based VOD and live video encoding. Supports H.264, H.265/HEVC, VP9, AV1 and more, along with adaptive bitrate packaging (HLS/DASH/Smooth Streaming), DRM (Widevine, PlayReady, FairPlay), and per-title encoding optimisation. 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/encodings/{encoding_id}/streams/{stream_id}/qc/psnr: post: tags: - Encodings summary: PSNR quality metrics description: Activates PSNR quality metrics for the selected stream operationId: ActivatePsnrStreamQualityMetrics parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Audio Mix configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/aac/{configuration_id}: delete: tags: - Configurations summary: Delete AAC Codec Configuration operationId: DeleteEncodingConfigurationsAudioAacByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/ac3/{configuration_id}: delete: deprecated: true tags: - Configurations summary: Delete AC3 Codec Configuration description: 'Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings ' operationId: DeleteEncodingConfigurationsAudioAc3ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dolby-digital/{configuration_id}: delete: tags: - Configurations summary: Delete Dolby Digital Codec Configuration operationId: DeleteEncodingConfigurationsAudioDDByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dolby-atmos/{configuration_id}: delete: tags: - Configurations summary: Delete Dolby Atmos Codec Configuration operationId: DeleteEncodingConfigurationsAudioDolbyAtmosByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dolby-digital-plus/{configuration_id}: delete: tags: - Configurations summary: Delete Dolby Digital Plus Codec Configuration operationId: DeleteEncodingConfigurationsAudioDolbyDDPlusByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dts/{configuration_id}: delete: tags: - Configurations summary: Delete DTS Codec Configuration operationId: DeleteEncodingConfigurationsAudioDtsByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dts-passthrough/{configuration_id}: delete: tags: - Configurations summary: Delete DTS Passthrough Codec Configuration operationId: DeleteEncodingConfigurationsAudioDtsPassthroughByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/dtsx/{configuration_id}: delete: tags: - Configurations summary: Delete DTS:X Codec Configuration operationId: DeleteEncodingConfigurationsAudioDtsXByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/eac3/{configuration_id}: delete: deprecated: true tags: - Configurations summary: Delete E-AC3 Codec Configuration description: 'Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings ' operationId: DeleteEncodingConfigurationsAudioEac3ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/he-aac-v1/{configuration_id}: delete: tags: - Configurations summary: Delete HE-AAC v1 Codec Configuration operationId: DeleteEncodingConfigurationsAudioHeAacV1ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/he-aac-v2/{configuration_id}: delete: tags: - Configurations summary: Delete HE-AAC v2 Codec Configuration operationId: DeleteEncodingConfigurationsAudioHeAacV2ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/mp2/{configuration_id}: delete: tags: - Configurations summary: Delete MP2 Codec Configuration operationId: DeleteEncodingConfigurationsAudioMp2ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/mp3/{configuration_id}: delete: tags: - Configurations summary: Delete MP3 Codec Configuration operationId: DeleteEncodingConfigurationsAudioMp3ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/opus/{configuration_id}: delete: tags: - Configurations summary: Delete Opus Codec Configuration operationId: DeleteEncodingConfigurationsAudioOpusByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/passthrough/{configuration_id}: delete: tags: - Configurations summary: Delete Audio Passthrough Codec Configuration operationId: DeleteEncodingConfigurationsAudioPassthroughByConfigurationId parameters: - name: configuration_id in: path description: Id of the audio configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the audio configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/pcm/{configuration_id}: delete: tags: - Configurations summary: Delete PCM Codec Configuration operationId: DeleteEncodingConfigurationsAudioPcmByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/audio/vorbis/{configuration_id}: delete: tags: - Configurations summary: Delete Vorbis Codec Configuration operationId: DeleteEncodingConfigurationsAudioVorbisByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/subtitles/dvb-subtitle/{configuration_id}: delete: tags: - Configurations summary: Delete DVB-SUB subtitle configuration operationId: DeleteEncodingConfigurationsSubtitlesDvbSubtitleByConfigurationId parameters: - name: configuration_id in: path description: Id of the subtitle configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the deleted configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/subtitles/imsc/{configuration_id}: delete: tags: - Configurations summary: Delete IMSC subtitle configuration operationId: DeleteEncodingConfigurationsSubtitlesImscByConfigurationId parameters: - name: configuration_id in: path description: Id of the subtitle configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the deleted configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/subtitles/webvtt/{configuration_id}: delete: tags: - Configurations summary: Delete WebVtt subtitle configuration operationId: DeleteEncodingConfigurationsSubtitlesWebVttByConfigurationId parameters: - name: configuration_id in: path description: Id of the subtitle configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the deleted configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/av1/{configuration_id}: delete: tags: - Configurations summary: Delete AV1 Codec Configuration operationId: DeleteEncodingConfigurationsVideoAv1ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/h262/{configuration_id}: delete: tags: - Configurations summary: Delete H262 Codec Configuration operationId: DeleteEncodingConfigurationsVideoH262ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/h264/{configuration_id}: delete: tags: - Configurations summary: Delete H264/AVC Codec Configuration operationId: DeleteEncodingConfigurationsVideoH264ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/h265/{configuration_id}: delete: tags: - Configurations summary: Delete H265/HEVC Codec Configuration operationId: DeleteEncodingConfigurationsVideoH265ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/mjpeg/{configuration_id}: delete: tags: - Configurations summary: Delete MJPEG Codec Configuration operationId: DeleteEncodingConfigurationsVideoMjpegByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: e7110fad-9076-4ca1-88f7-a29b66c2b78e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/vp8/{configuration_id}: delete: tags: - Configurations summary: Delete VP8 Codec Configuration operationId: DeleteEncodingConfigurationsVideoVp8ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/configurations/video/vp9/{configuration_id}: delete: tags: - Configurations summary: Delete VP9 Codec Configuration operationId: DeleteEncodingConfigurationsVideoVp9ByConfigurationId parameters: - name: configuration_id in: path description: Id of the codec configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the codec configuration default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}: delete: tags: - Encodings summary: Delete Encoding operationId: DeleteEncodingEncodingsByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the encoding default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/captions/scc/{captions_id}: delete: tags: - Encodings summary: Delete Convert SCC captions operationId: DeleteEncodingEncodingsCaptionsSccByEncodingIdAndCaptionsId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: captions_id in: path description: Id of the caption. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the caption default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/audio-mix/{input_stream_id}: delete: tags: - Encodings summary: Delete audio mix input stream operationId: DeleteEncodingEncodingsInputStreamsAudioMixByEncodingIdAndAudioMixInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the audio mix input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the audio mix input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/captions/cea608/{input_stream_id}: delete: tags: - Encodings summary: Delete CEA 608 Input Stream operationId: DeleteEncodingEncodingsInputStreamsCEA608ByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the CEA 608 input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CEA 608 Input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/captions/cea708/{input_stream_id}: delete: tags: - Encodings summary: Delete CEA 708 Input Stream operationId: DeleteEncodingEncodingsInputStreamsCEA708ByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the Encoding style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the CEA 708 input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CEA 708 Input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/concatenation/{input_stream_id}: delete: tags: - Encodings summary: Delete Concatenation Input Stream operationId: DeleteEncodingEncodingsInputStreamsConcatenationByEncodingIdAndConcatenationInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the Concatenation input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Concatenation input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/dolby-atmos/{input_stream_id}: delete: tags: - Encodings summary: Delete Dolby Atmos input stream operationId: DeleteEncodingEncodingsInputStreamsDolbyAtmosByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the Dolby Atmos input stream style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Dolby Atmos input stream default: description: Error response content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/dolby-vision/{dolby_vision_input_stream_id}: delete: tags: - Encodings summary: Delete Dolby Vision input stream operationId: DeleteEncodingEncodingsInputStreamsDolbyVisionByEncodingIdAndDolbyVisionInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: dolby_vision_input_stream_id in: path description: Id of the Dolby Vision input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Dolby Vision input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/sidecar/dolby-vision-metadata-ingest/{input_stream_id}: delete: tags: - Encodings summary: Delete Dolby Vision Metadata Ingest Input Stream operationId: DeleteEncodingEncodingsInputStreamsDolbyVisionMetadataIngestByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the Dolby Vision Metadata Ingest input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Dolby Vision Metadata Ingest input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/subtitles/dvb-subtitle/{input_stream_id}: delete: tags: - Encodings summary: Delete DVB Subtitle Input Stream operationId: DeleteEncodingEncodingsInputStreamsDvbSubtitleByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the DVB Subtitle Input Stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DVB Subtitle Input Stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/file/{input_stream_id}: delete: tags: - Encodings summary: Delete File stream operationId: DeleteEncodingEncodingsInputStreamsFileByEncodingIdAndFileInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the File input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the File input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/ingest/{input_stream_id}: delete: tags: - Encodings summary: Delete Ingest Input Stream operationId: DeleteEncodingEncodingsInputStreamsIngestByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the ingest input stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the ingest input stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/trimming/h264-picture-timing/{input_stream_id}: delete: tags: - Encodings summary: Delete H264 Picture Timing Trimming Input Stream operationId: DeleteEncodingEncodingsInputStreamsTrimmingH264PictureTimingByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the H264 Picture Timing Trimming Input Stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the H264 Picture Timing Trimming Input Stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/trimming/time-based/{input_stream_id}: delete: tags: - Encodings summary: Delete Time-Based Trimming Input Stream operationId: DeleteEncodingEncodingsInputStreamsTrimmingTimeBasedByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the Time-Based Trimming Input Stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Time-Based Trimming Input Stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/input-streams/trimming/timecode-track/{input_stream_id}: delete: tags: - Encodings summary: Delete Timecode Track Trimming Input Stream operationId: DeleteEncodingEncodingsInputStreamsTrimmingTimecodeTrackByEncodingIdAndInputStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: input_stream_id in: path description: Id of the Timecode Track Trimming Input Stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Timecode Track Trimming Input Stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/kantar-watermark: delete: tags: - Encodings summary: Delete the Kantar Watermark for an encoding operationId: DeleteEncodingEncodingsKantarWatermarkByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Kantar Watermark default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/keyframes/{keyframe_id}: delete: tags: - Encodings summary: Delete Keyframe operationId: DeleteEncodingEncodingsKeyframesByEncodingIdAndKeyframeId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: keyframe_id in: path description: Id of the keyframe. style: simple required: true schema: type: string example: e47151f2-cffb-4895-a3b9-0d4ed822705e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the keyframe default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/broadcast-ts/{muxing_id}: delete: tags: - Encodings summary: Delete Broadcast TS muxing operationId: DeleteEncodingEncodingsMuxingsBroadcastTsTsMuxingByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: ID of the Encoding. style: simple required: true schema: type: string example: 63c7b1ff-a57e-435d-80cb-bcea7752bcd1 - name: muxing_id in: path description: ID of the Broadcast TS muxing style: simple required: true schema: type: string example: 10fff470-813c-4cb7-963c-d020db4a7d83 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: ID of the Broadcast TS muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/chunked-text/{muxing_id}: delete: tags: - Encodings summary: Delete Chunked Text muxing operationId: DeleteEncodingEncodingsMuxingsChunkedTextByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Chunked Text muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Chunked Text muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/cmaf/{muxing_id}: delete: tags: - Encodings summary: Delete CMAF muxing operationId: DeleteEncodingEncodingsMuxingsCmafByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the CMAF muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CMAF muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}: delete: tags: - Encodings summary: Delete fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4ByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the fMP4 muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/aes/{drm_id}: delete: tags: - Encodings summary: Delete AES encryption configuration from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmAesByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the AES encryption configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the AES encryption configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/cenc/{drm_id}: delete: tags: - Encodings summary: Delete CENC DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmCencByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the cenc drm. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CENC DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/clearkey/{drm_id}: delete: tags: - Encodings summary: Delete ClearKey DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmClearkeyByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the ClearKey DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the ClearKey DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/fairplay/{drm_id}: delete: tags: - Encodings summary: Delete FairPlay DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmFairplayByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the FairPlay DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the FairPlay DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/marlin/{drm_id}: delete: tags: - Encodings summary: Delete Marlin DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmMarlinByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the Marlin DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Marlin DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/playready/{drm_id}: delete: tags: - Encodings summary: Delete PlayReady DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmPlayreadyByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the PlayReady DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the PlayReady DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/primetime/{drm_id}: delete: tags: - Encodings summary: Delete PrimeTime DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmPrimetimeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the PrimeTime DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the PrimeTime DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/fmp4/{muxing_id}/drm/widevine/{drm_id}: delete: tags: - Encodings summary: Delete Widevine DRM from an fMP4 muxing operationId: DeleteEncodingEncodingsMuxingsFmp4DrmWidevineByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the fMP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the widevine drm. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Widevine DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp3/{muxing_id}: delete: tags: - Encodings summary: Delete MP3 muxing operationId: DeleteEncodingEncodingsMuxingsMp3ByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP3 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the MP3 muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}: delete: tags: - Encodings summary: Delete MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4ByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the MP4 muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/cenc/{drm_id}: delete: tags: - Encodings summary: Delete CENC DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmCencByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the cenc drm. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CENC DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/clearkey/{drm_id}: delete: tags: - Encodings summary: Delete ClearKey DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmClearkeyByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the mp4. style: simple required: true schema: type: string example: 56f54472-510e-40d4-8ec8-951b09a9cbd9 - name: drm_id in: path description: Id of the ClearKey DRM configuration. style: simple required: true schema: type: string example: 342edd4f-2d48-4dc1-96e6-93c56eb17340 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the ClearKey DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/marlin/{drm_id}: delete: tags: - Encodings summary: Delete Marlin DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmMarlinByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the mp4. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the Marlin DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/MarlinDrm' - description: Id of the Marlin DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/playready/{drm_id}: delete: tags: - Encodings summary: Delete PlayReady DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmPlayreadyByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP4 muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the PlayReady DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the PlayReady DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mp4/{muxing_id}/drm/widevine/{drm_id}: delete: tags: - Encodings summary: Delete Widevine DRM from an MP4 muxing operationId: DeleteEncodingEncodingsMuxingsMp4DrmWidevineByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MP4 muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the widevine drm. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Widevine DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/mxf/{muxing_id}: delete: tags: - Encodings summary: Delete MXF muxing operationId: DeleteEncodingEncodingsMuxingsMXFByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the MXF muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the MXF muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/packed-audio/{muxing_id}: delete: tags: - Encodings summary: Delete Packed Audio muxing operationId: DeleteEncodingEncodingsMuxingsPackedAudioByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Packed Audio muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Packed Audio muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/packed-audio/{muxing_id}/drm/aes/{drm_id}: delete: tags: - Encodings summary: Delete AES encryption configuration from a Packed Audio muxing operationId: DeleteEncodingEncodingsMuxingsPackedAudioDrmAesByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Packed Audio muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the AES encryption configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the AES encryption configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-mov/{muxing_id}: delete: tags: - Encodings summary: Delete Progressive MOV muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveMovMovByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive MOV muxing style: simple required: true schema: type: string example: 6cc47877-b682-49bf-9e10-2b46f6eff1e2 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Progressive MOV muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/drm/aes/{drm_id}: delete: tags: - Encodings summary: Delete AES encryption configuration from a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsDrmAesByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive TS muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the AES encryption configuration style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the AES encryption configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/drm/fairplay/{drm_id}: delete: tags: - Encodings summary: Delete FairPlay DRM from a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsDrmFairplayByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive TS muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the FairPlay DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the FairPlay DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTSDrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive TS muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}: delete: tags: - Encodings summary: Delete Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsTsMuxingByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: ID of the Encoding. style: simple required: true schema: type: string example: 63c7b1ff-a57e-435d-80cb-bcea7752bcd1 - name: muxing_id in: path description: ID of the Progressive TS muxing style: simple required: true schema: type: string example: 10fff470-813c-4cb7-963c-d020db4a7d83 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: ID of the Progressive TS muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/id3/frame-id/{id3_tag_id}: delete: tags: - Encodings summary: Delete Frame ID ID3 Tag of a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsTsMuxingId3FrameIdId3TagByEncodingIdAndMuxingIdAndFrameidId3TagId parameters: - name: encoding_id in: path description: ID of the Encoding. style: simple required: true schema: type: string example: 7c850c77-3305-4aa7-8ffd-ac4a94549aeb - name: muxing_id in: path description: ID of the Progressive TS muxing style: simple required: true schema: type: string example: 1fd78356-eb0c-41d8-adea-f9248dad5fc8 - name: id3_tag_id in: path description: ID of the Frame ID ID3 Tag style: simple required: true schema: type: string example: 6c970971-0a47-45f0-9f54-f5fde8bfb645 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: ID of the Frame ID ID3 Tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/id3/plain-text/{id3_tag_id}: delete: tags: - Encodings summary: Delete Plain Text ID3 Tag of a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsTsMuxingId3PlainTextTextId3TagByEncodingIdAndMuxingIdAndPlainTextId3TagId parameters: - name: encoding_id in: path description: ID of the Encoding. style: simple required: true schema: type: string example: 7c850c77-3305-4aa7-8ffd-ac4a94549aeb - name: muxing_id in: path description: ID of the Progressive TS muxing style: simple required: true schema: type: string example: 1fd78356-eb0c-41d8-adea-f9248dad5fc8 - name: id3_tag_id in: path description: ID of the Plain Text ID3 Tag style: simple required: true schema: type: string example: 6c970971-0a47-45f0-9f54-f5fde8bfb645 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: ID of the Plain Text ID3 Tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-ts/{muxing_id}/id3/raw/{id3_tag_id}: delete: tags: - Encodings summary: Delete Raw ID3 Tag of a Progressive TS muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveTsTsMuxingId3RawId3TagByEncodingIdAndProgressiveTsMuxingIdAndRawId3TagId parameters: - name: encoding_id in: path description: ID of the Encoding. style: simple required: true schema: type: string example: 7c850c77-3305-4aa7-8ffd-ac4a94549aeb - name: muxing_id in: path description: ID of the Progressive TS muxing style: simple required: true schema: type: string example: 1fd78356-eb0c-41d8-adea-f9248dad5fc8 - name: id3_tag_id in: path description: ID of the RAW ID3 Tag style: simple required: true schema: type: string example: 6c970971-0a47-45f0-9f54-f5fde8bfb645 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: ID of the Raw ID3 Tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-wav/{muxing_id}: delete: tags: - Encodings summary: Delete Progressive WAV muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveWavByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive WAV muxing style: simple required: true schema: type: string example: 6cc47877-b682-49bf-9e10-2b46f6eff1e2 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Progressive WAV muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-webm/{muxing_id}/drm/cenc/{drm_id}: delete: tags: - Encodings summary: Delete CENC DRM from a Progressive WebM muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveWebmDrmCencByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the CENC DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CENC DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-webm/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from a Progressive WebM muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveWebmDrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/progressive-webm/{muxing_id}: delete: tags: - Encodings summary: Delete Progressive WebM muxing operationId: DeleteEncodingEncodingsMuxingsProgressiveWebmWebmByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Progressive WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Progressive WebM muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/segmented-raw/{muxing_id}: delete: tags: - Encodings summary: Delete Segmented RAW muxing operationId: DeleteEncodingEncodingsMuxingsSegmentedRawByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Segmented RAW muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Segmented RAW muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/text/{muxing_id}: delete: tags: - Encodings summary: Delete Text muxing operationId: DeleteEncodingEncodingsMuxingsTextByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the Text muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Text muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/ts/{muxing_id}: delete: tags: - Encodings summary: Delete TS muxing operationId: DeleteEncodingEncodingsMuxingsTsByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the TS muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the TS muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/ts/{muxing_id}/drm/aes/{drm_id}: delete: tags: - Encodings summary: Delete AES encryption configuration from a TS muxing operationId: DeleteEncodingEncodingsMuxingsTsDrmAesByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the TS muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the PlayReady DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the AES encryption configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/ts/{muxing_id}/drm/fairplay/{drm_id}: delete: tags: - Encodings summary: Delete FairPlay DRM from a TS muxing operationId: DeleteEncodingEncodingsMuxingsTsDrmFairplayByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the TS muxing. style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the FairPlay DRM configuration. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the FairPlay DRM configuration. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/ts/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from a TS muxing operationId: DeleteEncodingEncodingsMuxingsTsDrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the TS muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/webm/{muxing_id}: delete: tags: - Encodings summary: Delete WebM muxing operationId: DeleteEncodingEncodingsMuxingsWebmByEncodingIdAndMuxingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the WebM muxing default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/webm/{muxing_id}/drm/cenc/{drm_id}: delete: tags: - Encodings summary: Delete CENC DRM from a WebM muxing operationId: DeleteEncodingEncodingsMuxingsWebmDrmCencByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the cenc drm. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CENC DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/muxings/webm/{muxing_id}/drm/speke/{drm_id}: delete: tags: - Encodings summary: Delete SPEKE DRM from a WebM muxing operationId: DeleteEncodingEncodingsMuxingsWebmDrmSpekeByEncodingIdAndMuxingIdAndDrmId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: muxing_id in: path description: Id of the WebM muxing style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de - name: drm_id in: path description: Id of the SPEKE DRM. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SPEKE DRM default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/live/insertable-content/{content_id}/schedule/{scheduled_content_id}: delete: tags: - Encodings summary: Deschedule Insertable Content operationId: DeleteEncodingEncodingsScheduledInsertableContentByEncodingIdAndContentIdAndScheduledContentId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: content_id in: path description: Id of the insertable content. style: simple required: true schema: type: string example: 6c6ca0db-7263-4013-b719-2f3d817520ec - name: scheduled_content_id in: path description: Id of the scheduled insertable content style: simple required: true schema: type: string example: 5d8fb60a-8422-4d95-8157-b625413036de responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the scheduled insertable content default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/scte-35-triggers/{scte35trigger_id}: delete: tags: - Encodings summary: Delete SCTE 35 trigger description: 'This endpoint supports VOD encodings only. Requests made with a live encoding ID will fail. ' operationId: DeleteEncodingEncodingsScte35TriggersByEncodingIdAndScte35TriggerId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: scte35trigger_id in: path description: Id of the SCTE 35 trigger style: simple required: true schema: type: string example: 4225f469-f868-4265-ab58-2e817c8c9be0 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the SCTE 35 trigger default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/sidecars/{sidecar_id}: delete: tags: - Encodings summary: Delete Sidecar operationId: DeleteEncodingEncodingsSidecarByEncodingIdAndSidecarId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: sidecar_id in: path description: Id of the sidecar. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the sidecar default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/sidecars/webvtt/{sidecar_id}: delete: tags: - Encodings summary: Delete Sidecar operationId: DeleteEncodingEncodingsSidecarsWebVttByEncodingIdAndSidecarId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: sidecar_id in: path description: Id of the sidecar. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the sidecar default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/bifs/{bif_id}: delete: tags: - Encodings summary: Delete Bif operationId: DeleteEncodingEncodingsStreamsBifsByEncodingIdAndStreamIdAndBifId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: bif_id in: path description: Id of the Bif. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Bif default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}: delete: tags: - Encodings summary: Delete Stream operationId: DeleteEncodingEncodingsStreamsByEncodingIdAndStreamId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the stream default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/scc/{captions_id}: delete: tags: - Encodings summary: Delete SCC captions as 608/708 from Stream operationId: DeleteEncodingEncodingsStreamsCaptions608708SccByEncodingIdAndStreamIdAndCaptionsId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: captions_id in: path description: Id of the caption. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the caption default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt/{captions_id}: delete: tags: - Encodings summary: Delete SRT captions as 608/708 from Stream operationId: DeleteEncodingEncodingsStreamsCaptions608708SrtByEncodingIdAndStreamIdAndCaptionsId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: captions_id in: path description: Id of the caption. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the caption default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/hdr/dolby-vision/{hdr_id}: delete: tags: - Encodings summary: Delete Dolby Vision Metadata operationId: DeleteEncodingEncodingsStreamsDolbyVisionHdrMetadataByEncodingIdAndStreamIdAndDolbyVisionHdrMetadataId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: hdr_id in: path description: Id of the Dolby Vision Metadata. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Dolby Vision Metadata default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/filters: delete: tags: - Encodings summary: Delete All Filters from Stream operationId: DeleteEncodingEncodingsStreamsFiltersByEncodingIdAndStreamId x-bitmovin: operationName: deleteAll parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponseList' - description: List of ids of deleted stream filters default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/filters/{filter_id}: delete: tags: - Encodings summary: Delete Specific Filter from Stream operationId: DeleteEncodingEncodingsStreamsFiltersByEncodingIdAndStreamIdAndFilterId x-bitmovin: operationName: delete parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: filter_id in: path description: Id of the filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f6 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the filter default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/sprites/{sprite_id}: delete: tags: - Encodings summary: Delete Sprite operationId: DeleteEncodingEncodingsStreamsSpritesByEncodingIdAndStreamIdAndSpriteId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: sprite_id in: path description: Id of the sprite. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the sprite default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/burn-in-subtitles/assa/{subtitle_id}: delete: tags: - Encodings summary: Delete Burn-In ASSA Subtitle from Stream operationId: DeleteEncodingEncodingsStreamsSubtitlesAssaByEncodingIdAndStreamIdAndSubtitleId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: subtitle_id in: path description: Id of the burn-in subtitle. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the burn-in ASSA subtitle default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/burn-in-subtitles/dvbsub/{subtitle_id}: delete: tags: - Encodings summary: Delete Burn-In DVB-SUB Subtitle from Stream operationId: DeleteEncodingEncodingsStreamsSubtitlesDvbsubByEncodingIdAndStreamIdAndSubtitleId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: subtitle_id in: path description: Id of the subtitle. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the subtitle default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/burn-in-subtitles/srt/{subtitle_id}: delete: tags: - Encodings summary: Delete Burn-In SRT Subtitle from Stream operationId: DeleteEncodingEncodingsStreamsSubtitlesSrtsubByEncodingIdAndStreamIdAndSubtitleId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: subtitle_id in: path description: Id of the burn-in subtitle. style: simple required: true schema: type: string example: 81424b3f-98ce-4dbf-a4c0-8b4d515150f3 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the burn-in SRT subtitle default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/thumbnails/{thumbnail_id}: delete: tags: - Encodings summary: Delete Thumbnail operationId: DeleteEncodingEncodingsStreamsThumbnailsByEncodingIdAndStreamIdAndThumbnailId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: thumbnail_id in: path description: Id of the thumbnail. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the thumbnail default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/encodings/{encoding_id}/streams/{stream_id}/watermarking/nexguard-file-marker/{nexguard_id}: delete: tags: - Encodings summary: Delete nexguard file marker watermarking configurations operationId: DeleteEncodingEncodingsStreamsWatermarkingNexGuardFileMarkerByEncodingIdAndStreamIdAndNexguardId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 - name: stream_id in: path description: Id of the stream. style: simple required: true schema: type: string example: a6336204-c929-4a61-b7a0-2cd6665114e9 - name: nexguard_id in: path description: Id of the nexguard file marker watermarking configurations style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the nexguard file marker watermarking configurations. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/audio-mix/{filter_id}: delete: tags: - Filters summary: Delete Audio Mix Filter operationId: DeleteEncodingFiltersAudioMixMixByFilterId parameters: - name: filter_id in: path description: Id of the Audio Mix Filter. style: simple required: true schema: type: string example: dddd9f25-1cf5-4bb0-b465-69055e9569f9 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Audio Mix Filter default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/audio-volume/{filter_id}: delete: tags: - Filters summary: Delete Audio Volume Filter operationId: DeleteEncodingFiltersAudioVolumeVolumeByFilterId parameters: - name: filter_id in: path description: Id of the Audio Volume Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Audio volume. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/azure-speech-to-captions/{filter_id}: delete: tags: - Filters summary: Delete Azure Speech to captions Filter operationId: DeleteEncodingFiltersAzureSpeechToCaptionsByFilterId parameters: - name: filter_id in: path description: Id of the Azure Speech to captions Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Azure Speech to captions filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/conform/{filter_id}: delete: tags: - Filters summary: Delete Conform Filter operationId: DeleteEncodingFiltersConformByFilterId parameters: - name: filter_id in: path description: Id of the conform filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Conform Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/crop/{filter_id}: delete: tags: - Filters summary: Delete Crop Filter operationId: DeleteEncodingFiltersCropByFilterId parameters: - name: filter_id in: path description: Id of the Crop Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/deinterlace/{filter_id}: delete: tags: - Filters summary: Delete Deinterlace Filter operationId: DeleteEncodingFiltersDeinterlaceByFilterId parameters: - name: filter_id in: path description: Id of the Deinterlace Filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Deinterlace Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/denoise-hqdn3d/{filter_id}: delete: tags: - Filters summary: Delete Denoise hqdn3d Filter operationId: DeleteEncodingFiltersDenoiseHqdn3dHqdn3dByFilterId parameters: - name: filter_id in: path description: Id of the denoise hqdn3d filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the denoise hqdn3d filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/ebu-r128-single-pass/{filter_id}: delete: tags: - Filters summary: Delete EBU R128 Single Pass Filter operationId: DeleteEncodingFiltersEbuR128SinglePassByFilterId parameters: - name: filter_id in: path description: Id of the EBU R128 Single Pass filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the EBU R128 Single Pass filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/enhanced-deinterlace/{filter_id}: delete: tags: - Filters summary: Delete Enhanced Deinterlace Filter operationId: DeleteEncodingFiltersEnhancedDeinterlaceByFilterId parameters: - name: filter_id in: path description: Id of the Enhanced Deinterlace Filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Enhanced Deinterlace Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/enhanced-watermark/{filter_id}: delete: tags: - Filters summary: Delete Enhanced Watermark Filter operationId: DeleteEncodingFiltersEnhancedWatermarkWatermarkByFilterId parameters: - name: filter_id in: path description: Id of the enhanced Watermark Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Enhanced Watermark Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/interlace/{filter_id}: delete: tags: - Filters summary: Delete Interlace Filter operationId: DeleteEncodingFiltersInterlaceByFilterId parameters: - name: filter_id in: path description: Id of the Interlace Filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Interlace Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/rotate/{filter_id}: delete: tags: - Filters summary: Delete Rotate Filter operationId: DeleteEncodingFiltersRotateByFilterId parameters: - name: filter_id in: path description: Id of the Rotate Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Rotate Filter default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/scale/{filter_id}: delete: tags: - Filters summary: Delete Scale Filter operationId: DeleteEncodingFiltersScaleByFilterId parameters: - name: filter_id in: path description: Id of the scale filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Scale Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/text/{filter_id}: delete: tags: - Filters summary: Delete Text Filter operationId: DeleteEncodingFiltersTextByFilterId parameters: - name: filter_id in: path description: Id of the Text Filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Text Filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/unsharp/{filter_id}: delete: tags: - Filters summary: Delete Unsharp Filter operationId: DeleteEncodingFiltersUnsharpByFilterId parameters: - name: filter_id in: path description: Id of the unsharp filter style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the unsharp filter. default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/filters/watermark/{filter_id}: delete: tags: - Filters summary: Delete Watermark Filter operationId: DeleteEncodingFiltersWatermarkByFilterId parameters: - name: filter_id in: path description: Id of the Watermark Filter. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Watermark Filter default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/akamai/{infrastructure_id}: delete: tags: - Infrastructure summary: Delete Akamai account operationId: DeleteEncodingInfrastructureAkamaiByInfrastructureId parameters: - name: infrastructure_id in: path description: Id of the Akamai account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiAccount' - description: Akamai account default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/akamai/{infrastructure_id}/regions/{region}: delete: tags: - Infrastructure summary: Delete Akamai account region settings operationId: DeleteEncodingInfrastructureAkamaiRegionsByInfrastructureIdAndRegion parameters: - name: infrastructure_id in: path description: Id of the Akamai account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 - name: region in: path description: Akamai region style: simple required: true schema: $ref: '#/components/schemas/AkamaiCloudRegion' example: FR_PAR responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiAccountRegionSettings' - description: Akamai account region settings default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/aws/{infrastructure_id}: delete: tags: - Infrastructure summary: Delete AWS Account operationId: DeleteEncodingInfrastructureAwsByInfrastructureId parameters: - name: infrastructure_id in: path description: Id of the AWS account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AwsAccount' - description: AWS account default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/aws/{infrastructure_id}/regions/{region}: delete: tags: - Infrastructure summary: Delete AWS Region Settings operationId: DeleteEncodingInfrastructureAwsRegionsByInfrastructureIdAndRegion parameters: - name: infrastructure_id in: path description: Id of the AWS account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 - name: region in: path description: AWS region. style: simple required: true schema: $ref: '#/components/schemas/AwsCloudRegion' example: EU_WEST_1 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AwsAccountRegionSettings' - description: Region settings for specified region default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/azure/{infrastructure_id}: delete: tags: - Infrastructure summary: Delete Azure Account operationId: DeleteEncodingInfrastructureAzureByInfrastructureId parameters: - name: infrastructure_id in: path description: Id of the Azure account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AzureAccount' - description: Azure account default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/azure/{infrastructure_id}/regions/{region}: delete: tags: - Infrastructure summary: Delete Azure Region Settings operationId: DeleteEncodingInfrastructureAzureRegionsByInfrastructureIdAndRegion parameters: - name: infrastructure_id in: path description: Id of the Azure account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 - name: region in: path description: Azure region. style: simple required: true schema: $ref: '#/components/schemas/AzureCloudRegion' example: EU_WEST_1 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AzureAccountRegionSettings' - description: Region settings for specified region default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/gce/{infrastructure_id}: delete: tags: - Infrastructure summary: Delete GCE Account operationId: DeleteEncodingInfrastructureGceByInfrastructureId parameters: - name: infrastructure_id in: path description: Id of the GCE account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GceAccount' - description: GCE account default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/gce/{infrastructure_id}/regions/{region}: delete: tags: - Infrastructure summary: Delete Google Cloud Region Settings operationId: DeleteEncodingInfrastructureGceRegionsByInfrastructureIdAndRegion parameters: - name: infrastructure_id in: path description: Id of the Google Cloud Connect infrastructure resource style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 - name: region in: path description: Google Cloud Region style: simple required: true schema: $ref: '#/components/schemas/GoogleCloudRegion' example: US_EAST_1 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GceAccountRegionSettings' - description: Region settings for specified region default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/oci/{infrastructure_id}: delete: tags: - Infrastructure summary: Delete OCI account operationId: DeleteEncodingInfrastructureOciByInfrastructureId parameters: - name: infrastructure_id in: path description: Id of the OCI account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/OciAccount' - description: OCI account default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/oci/{infrastructure_id}/regions/{region}: delete: tags: - Infrastructure summary: Delete OCI account region settings operationId: DeleteEncodingInfrastructureOciRegionsByInfrastructureIdAndRegion parameters: - name: infrastructure_id in: path description: Id of the OCI account style: simple required: true schema: type: string example: 468aca07-6556-4425-a79b-8433f18cec64 - name: region in: path description: OCI region style: simple required: true schema: $ref: '#/components/schemas/OciCloudRegion' example: EU_FRANKFURT_1 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/OciAccountRegionSettings' - description: OCI account region settings default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/prewarmed-encoder-pools/{pool_id}: delete: tags: - Infrastructure summary: Delete prewarmed encoder pool operationId: DeleteEncodingInfrastructurePrewarmedEncoderPoolsByPoolId parameters: - name: pool_id in: path description: Id of the prewarmed encoder pool style: simple required: true schema: type: string example: 122fc55e-0fc2-4d38-8a07-55330996d527 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the prewarmed encoder pool that was deleted default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/prewarmed-encoder-pools/{pool_id}/schedules/{schedule_id}: delete: tags: - Infrastructure summary: Delete prewarmed encoder pool schedule operationId: DeleteEncodingInfrastructurePrewarmedEncoderPoolsSchedulesByPoolIdAndScheduleId parameters: - name: pool_id in: path description: Id of the scheduled encoder pool style: simple required: true schema: type: string example: 122fc55e-0fc2-4d38-8a07-55330996d527 - name: schedule_id in: path description: Id of the prewarmed encoder pool schedule style: simple required: true schema: type: string example: 5b647d74-4770-4130-a5b9-9e3d3cae7ee6 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the prewarmed encoder pool schedule that was deleted default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/infrastructure/static-ips/{id}: delete: tags: - Infrastructure summary: Delete Static IP Address operationId: DeleteEncodingInfrastructureStaticIpById parameters: - name: id in: path description: Id of the Static IP Address style: simple required: true schema: type: string example: 32bb812d-30a6-4c93-88a0-9253bea13083 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Static IP Address default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/akamai-netstorage/{input_id}: delete: tags: - Inputs summary: Delete Akamai NetStorage Input operationId: DeleteEncodingInputsAkamaiNetStorageByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: 2a56cb20-3fc5-4849-82eb-049edaa04022 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiNetStorageInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/aspera/{input_id}: delete: tags: - Inputs summary: Delete Aspera Input operationId: DeleteEncodingInputsAsperaByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AsperaInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/azure/{input_id}: delete: tags: - Inputs summary: Delete Azure Input operationId: DeleteEncodingInputsAzureByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AzureInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/direct-file-upload/{input_id}: delete: tags: - Inputs summary: Delete Direct File Upload Input operationId: DeleteEncodingInputsDirectFileUploadByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the deleted input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/ftp/{input_id}: delete: tags: - Inputs summary: Delete FTP Input operationId: DeleteEncodingInputsFtpByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/FtpInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/gcs/{input_id}: delete: tags: - Inputs summary: Delete GCS Input operationId: DeleteEncodingInputsGcsByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/gcs-service-account/{input_id}: delete: tags: - Inputs summary: Delete Service Account based GCS Input operationId: DeleteEncodingInputsGcsServiceAccountByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsServiceAccountInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/generic-s3/{input_id}: delete: tags: - Inputs summary: Delete Generic S3 Input operationId: DeleteEncodingInputsGenericS3ByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: 1a56e6d6-69e9-4e4d-a004-1f85a2b8cc92 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GenericS3Input' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/hls/{input_id}: delete: tags: - Inputs summary: Delete HLS Input operationId: DeleteEncodingInputsHLSByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/HlsInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/http/{input_id}: delete: tags: - Inputs summary: Delete HTTP Input operationId: DeleteEncodingInputsHttpByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/HttpInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/https/{input_id}: delete: tags: - Inputs summary: Delete HTTPS Input operationId: DeleteEncodingInputsHttpsByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/HttpsInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/local/{input_id}: delete: tags: - Inputs summary: Delete Local Input operationId: DeleteEncodingInputsLocalByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: 1a56e6d6-69e9-4e4d-a004-1f85a2b8cc92 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/redundant-rtmp/{input_id}: delete: tags: - Inputs summary: Delete Redundant RTMP Input operationId: DeleteEncodingInputsRedundantRtmpById parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/s3/{input_id}: delete: tags: - Inputs summary: Delete S3 Input operationId: DeleteEncodingInputsS3ByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the deleted input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/s3-role-based/{input_id}: delete: tags: - Inputs summary: Delete S3 Role-based Input operationId: DeleteEncodingInputsS3RoleBasedByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/S3RoleBasedInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/sftp/{input_id}: delete: tags: - Inputs summary: Delete SFTP Input operationId: DeleteEncodingInputsSftpByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SftpInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/srt/{input_id}: delete: tags: - Inputs summary: Delete SRT input operationId: DeleteEncodingInputsSrtByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SrtInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/zixi/{input_id}: delete: tags: - Inputs summary: Delete Zixi input operationId: DeleteEncodingInputsZixiByInputId parameters: - name: input_id in: path description: Id of the input style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ZixiInput' - description: Id of the input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/encodings/{encoding_id}/dns-mappings: delete: tags: - Live summary: Delete all DNS mappings for encoding operationId: DeleteEncodingLiveEncodingsDnsMappingsByEncodingId x-bitmovin: operationName: deleteAll parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: be274f1d-c988-4583-8f82-f725de74f002 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponseList' - description: List of ids of deleted DNS mappings default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' post: tags: - Live summary: Create new DNS mapping for encoding operationId: PostEncodingLiveEncodingsDnsMappingsByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: be274f1d-c988-4583-8f82-f725de74f002 requestBody: description: The DNS mapping to be created content: application/json: schema: $ref: '#/components/schemas/DnsMappingRequest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/DnsMappingResponse' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/encodings/{encoding_id}/dns-mappings/{id}: delete: tags: - Live summary: Delete DNS mapping operationId: DeleteEncodingLiveEncodingsDnsMappingsByEncodingIdAndId parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: be274f1d-c988-4583-8f82-f725de74f002 - name: id in: path description: Id of the DNS mapping style: simple required: true schema: type: string example: 6f312857-3c19-40d7-aae4-bc97f3a646e4 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DNS mapping that was deleted default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/stream-keys/{stream_key_id}: delete: tags: - Live summary: Delete Stream Key operationId: DeleteEncodingLiveStreamKeysByStreamKeyId parameters: - name: stream_key_id in: path description: Id of the stream key style: simple required: true schema: type: string example: 6f312857-3c19-40d7-aae4-bc97f3a646e4 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the stream key that was deleted default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}: delete: tags: - Manifests summary: Delete DASH Manifest operationId: DeleteEncodingManifestsDashByManifestId parameters: - name: manifest_id in: path description: UUID of the DASH Manifest to be deleted style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DASH Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/audio/{adaptationset_id}: delete: tags: - Manifests summary: Delete Audio AdaptationSet operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsAudioByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the audio adaptation set to be deleted style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Audio AdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/contentprotection/{contentprotection_id} : delete: tags: - Manifests summary: Delete AdaptationSet Content Protection operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndContentprotectionId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: contentprotection_id in: path description: Id of the adaptation set content protection to be deleted style: simple required: true schema: type: string example: 60bd481a-3524-4091-9cef-a2ec7aaa8110 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the AdaptationSet Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image/{adaptationset_id}: delete: tags: - Manifests summary: Delete Image AdaptationSet operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsImageByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the audio adaptation set to be deleted style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Image AdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/chunked-text/{representation_id} : delete: tags: - Manifests summary: Delete Chunked Text Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsChunkedTextByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the Chunked Text Representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Chunked Text Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/cmaf/{representation_id} : delete: tags: - Manifests summary: Delete CMAF Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsCmafByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the CMAF representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CMAF Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/cmaf/{representation_id}/contentprotection/{contentprotection_id} : delete: tags: - Manifests summary: Delete CMAF Representation Content Protection operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsCmafContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationIdAndContentprotectionId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d - name: contentprotection_id in: path description: Id of the DRM CMAF content protection to be deleted style: simple required: true schema: type: string example: 60bd481a-3524-4091-9cef-a2ec7aaa8110 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the CMAF Representation Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/{representation_id} : delete: tags: - Manifests summary: Delete fMP4 Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4ByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the fMP4 representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the fMP4 Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/{representation_id}/contentprotection/{contentprotection_id} : delete: tags: - Manifests summary: Delete fMP4 Representation Content Protection operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4ContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationIdAndContentprotectionId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d - name: contentprotection_id in: path description: Id of the DRM fMP4 content protection to be deleted style: simple required: true schema: type: string example: 60bd481a-3524-4091-9cef-a2ec7aaa8110 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the fMP4 Representation Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/drm/{representation_id} : delete: tags: - Manifests summary: Delete DRM fMP4 Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4DrmByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the DRM fMP4 representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DRM fMP4 Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/drm/{representation_id}/contentprotection/{contentprotection_id} : delete: tags: - Manifests summary: Delete DRM fMP4 Representation Content Protection operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4DrmContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationIdAndContentprotectionId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d - name: contentprotection_id in: path description: Id of the DRM fMP4 content protection to be deleted style: simple required: true schema: type: string example: 60bd481a-3524-4091-9cef-a2ec7aaa8110 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DRM fMP4 Representation Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/imsc/{representation_id} : delete: tags: - Manifests summary: Delete IMSC Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsImscByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the IMSC representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the IMSC Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/mp4/{representation_id} : delete: tags: - Manifests summary: Delete MP4 Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsMp4ByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the MP4 representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the MP4 Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/mp4/drm/{representation_id} : delete: tags: - Manifests summary: Delete DRM MP4 Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsMp4DrmByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the DRM MP4 representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DRM MP4 Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/progressive-webm/{representation_id} : delete: tags: - Manifests summary: Delete Progressive WebM Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsProgressiveWebmByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the Progressive WebM representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Progressive WebM Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite/{representation_id} : delete: tags: - Manifests summary: Delete Sprite Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsSpriteByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the Sprite representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Sprite Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/vtt/{representation_id} : delete: tags: - Manifests summary: Delete VTT Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsVttByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the VTT representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the VTT Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/webm/{representation_id} : delete: tags: - Manifests summary: Delete WebM Representation operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsWebmByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the WebM representation to be deleted style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the WebM Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/webm/{representation_id}/contentprotection/{contentprotection_id} : delete: tags: - Manifests summary: Delete WebM Representation Content Protection operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsRepresentationsWebmContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationIdAndContentprotectionId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d - name: contentprotection_id in: path description: Id of the DRM WebM content protection to be deleted style: simple required: true schema: type: string example: 60bd481a-3524-4091-9cef-a2ec7aaa8110 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the WebM Representation Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/subtitle/{adaptationset_id}: delete: tags: - Manifests summary: Delete Subtitle AdaptationSet operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsSubtitleByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the subtitle adaptation set to be deleted style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Subtitle AdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/video/{adaptationset_id}: delete: tags: - Manifests summary: Delete Video AdaptationSet operationId: DeleteEncodingManifestsDashPeriodsAdaptationsetsVideoByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the video adaptation set to be deleted style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Video AdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}: delete: tags: - Manifests summary: Delete Period operationId: DeleteEncodingManifestsDashPeriodsByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period to be deleted style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Period default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/custom-xml-elements/{custom_xml_element_id}: delete: tags: - Manifests summary: Delete Custom XML Element operationId: DeleteEncodingManifestsDashPeriodsCustomXmlElementsXmlElementByManifestIdAndPeriodIdAndCustomXmlElementId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: custom_xml_element_id in: path description: Id of the Custom XML Element style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Custom XML Element default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}: delete: tags: - Manifests summary: Delete HLS Manifest operationId: DeleteEncodingManifestsHlsByManifestId parameters: - name: manifest_id in: path description: Id of the HLS Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the HLS manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/audio/{media_id}: delete: tags: - Manifests summary: Delete Audio Media operationId: DeleteEncodingManifestsHlsMediaAudioByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the audio media. style: simple required: true schema: type: string example: 3009c63c-5014-4750-be28-91d609555c19 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the audio media default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/closed-captions/{media_id}: delete: tags: - Manifests summary: Delete Closed Captions Media operationId: DeleteEncodingManifestsHlsMediaClosedCaptionsByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the closed captions media. style: simple required: true schema: type: string example: 49019b21-21fb-4b0a-9dd5-fd667c59b059 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the closed captions media default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/{media_id}/custom-tags/{custom_tag_id}: delete: tags: - Manifests summary: Delete Custom Tag operationId: DeleteEncodingManifestsHlsMediaCustomTagByManifestIdAndMediaIdAndCustomTagId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the media. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 - name: custom_tag_id in: path description: Id of the custom tag. style: simple required: true schema: type: string example: 27786ce5-eaaf-41b7-82be-b82f4ae96194 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the custom tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/subtitles/{media_id}: delete: tags: - Manifests summary: Delete Subtitles Media operationId: DeleteEncodingManifestsHlsMediaSubtitlesByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the subtitles media. style: simple required: true schema: type: string example: fdc2d456-7a2d-4e56-b712-fb08c7c8a63e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the subtitles media default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/video/{media_id}: delete: tags: - Manifests summary: Delete Video Media operationId: DeleteEncodingManifestsHlsMediaVideoByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the video media. style: simple required: true schema: type: string example: 95ce19cc-be6d-43f9-9e10-fffa3a142a9c responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the video media default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/vtt/{media_id}: delete: tags: - Manifests summary: Delete VTT Media operationId: DeleteEncodingManifestsHlsMediaVttByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the VTT media. style: simple required: true schema: type: string example: fdc2d456-7a2d-4e56-b712-fb08c7c8a63e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the VTT media default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams/{stream_id}: delete: tags: - Manifests summary: Delete Variant Stream operationId: DeleteEncodingManifestsHlsStreamsByManifestIdAndStreamId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: stream_id in: path description: Id of the variant stream. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the stream inf default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams/{stream_id}/custom-tags/{custom_tag_id}: delete: tags: - Manifests summary: Delete Custom Tag operationId: DeleteEncodingManifestsHlsStreamsCustomTagByManifestIdAndStreamIdAndCustomTagId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: stream_id in: path description: Id of the variant stream. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 - name: custom_tag_id in: path description: Id of the custom tag. style: simple required: true schema: type: string example: 27786ce5-eaaf-41b7-82be-b82f4ae96194 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the custom tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams/{stream_id}/iframe/{iframe_id}: delete: tags: - Manifests summary: Delete I-frame playlist operationId: DeleteEncodingManifestsHlsStreamsIframeByManifestIdAndStreamIdAndIframeId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: stream_id in: path description: Id of the variant stream. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 - name: iframe_id in: path description: Id of the Iframe-Playlist. style: simple required: true schema: type: string example: 27786ce5-eaaf-41b7-82be-b82f4ae96194 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the custom tag default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}: delete: tags: - Manifests summary: Delete Smooth Streaming Manifest operationId: DeleteEncodingManifestsSmoothByManifestId parameters: - name: manifest_id in: path description: Id of the Smooth Streaming Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/contentprotection/{protection_id}: delete: tags: - Manifests summary: Delete Content Protection of Smooth Streaming operationId: DeleteEncodingManifestsSmoothContentprotectionByManifestIdAndProtectionId parameters: - name: manifest_id in: path description: Id of the Smooth Streaming manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: protection_id in: path description: Id of the content protection. style: simple required: true schema: type: string example: b7519c28-8dae-4596-ae91-ddc0c2bc5d62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the content protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/representations/mp4/{representation_id}: delete: tags: - Manifests summary: Delete Smooth Streaming MP4 Representation operationId: DeleteEncodingManifestsSmoothRepresentationsMp4ByManifestIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the Smooth Streaming manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: representation_id in: path description: Id of the MP4 representation. style: simple required: true schema: type: string example: 36919308-f99a-46f0-932a-5cd838573869 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/akamai-msl/{output_id}: delete: tags: - Outputs summary: Delete Akamai MSL Output operationId: DeleteEncodingOutputsAkamaiMslByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: 05edf91d-05f3-4ecd-998f-b28f75027b5e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/akamai-netstorage/{output_id}: delete: tags: - Outputs summary: Delete Akamai NetStorage Output operationId: DeleteEncodingOutputsAkamaiNetStorageByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: 05edf91d-05f3-4ecd-998f-b28f75027b5e responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiNetStorageOutput' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/azure/{output_id}: delete: tags: - Outputs summary: Delete Azure Output operationId: DeleteEncodingOutputsAzureByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AzureOutput' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/ftp/{output_id}: delete: tags: - Outputs summary: Delete FTP Output operationId: DeleteEncodingOutputsFtpByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/FtpOutput' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/gcs/{output_id}: delete: tags: - Outputs summary: Delete GCS Output operationId: DeleteEncodingOutputsGcsByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsOutput' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/gcs-service-account/{output_id}: delete: tags: - Outputs summary: Delete Service Account based GCS Output operationId: DeleteEncodingOutputsGcsServiceAccountByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsServiceAccountOutput' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/generic-s3/{output_id}: delete: tags: - Outputs summary: Delete Generic S3 Output operationId: DeleteEncodingOutputsGenericS3ByOutputId parameters: - name: output_id in: path description: Id of the output style: simple required: true schema: type: string example: 1a56e6d6-69e9-4e4d-a004-1f85a2b8cc92 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GenericS3Output' - description: Id of the output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/s3-role-based: post: tags: - Inputs summary: Create S3 Role-based Input operationId: PostEncodingInputsS3RoleBased requestBody: description: "The S3 Role-based input to be created\n\nThe following permissions\ \ are required for S3 Role-based input:\n * s3:GetObject\n * s3:GetBucketLocation,\n" content: application/json: schema: $ref: '#/components/schemas/S3RoleBasedInput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/S3RoleBasedInput' - description: S3 Role-based Input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/sftp: post: tags: - Inputs summary: Create SFTP Input operationId: PostEncodingInputsSftp requestBody: description: The SFTP input to be created content: application/json: schema: $ref: '#/components/schemas/SftpInput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SftpInput' - description: SFTP input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/srt: post: tags: - Inputs summary: Create SRT input operationId: PostEncodingInputsSrt requestBody: description: The SrtInput to be created content: application/json: schema: $ref: '#/components/schemas/SrtInput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SrtInput' - description: SRT input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/inputs/zixi: post: tags: - Inputs summary: Create Zixi input operationId: PostEncodingInputsZixi requestBody: description: The ZixiInput to be created content: application/json: schema: $ref: '#/components/schemas/ZixiInput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ZixiInput' - description: Zixi input default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/standby-pools: post: tags: - Live summary: Create new standby pool operationId: PostEncodingLiveStandbyPools requestBody: description: The pool to be created content: application/json: schema: $ref: '#/components/schemas/LiveStandbyPoolRequest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/LiveStandbyPoolDetails' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/standby-pools/{pool_id}/actions/acquire-encoding: post: tags: - Live summary: Acquire an encoding from a standby pool operationId: PostEncodingLiveStandbyPoolsActionsAcquireEncoding x-bitmovin: isRpc: true operationName: acquireEncoding optionalRequestBody: true parameters: - name: pool_id in: path description: Id of the standby pool style: simple required: true schema: type: string example: 64681f1e-fb73-45d3-a492-4fc5fdc35701 requestBody: description: The optionally provided payload for acquiring an encoding content: application/json: schema: $ref: '#/components/schemas/LiveStandbyPoolAcquireEncoding' responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/LiveStandbyPoolEncoding' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/stream-keys: post: tags: - Live summary: Create new stream key operationId: PostEncodingLiveStreamKeys requestBody: description: The stream key to be created content: application/json: schema: $ref: '#/components/schemas/StreamKey' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/StreamKey' '409': description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/stream-keys/actions/unassign: post: tags: - Live summary: Unassign stream keys operationId: PostEncodingLiveStreamKeysActionsStreamKeyUnassign x-bitmovin: isRpc: true operationName: unassign requestBody: description: The action payload for unassigning stream keys content: application/json: schema: $ref: '#/components/schemas/StreamKeysUnassignAction' responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/StreamKeysUnassignAction' - description: Stream key default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash: post: tags: - Manifests summary: Create Custom DASH Manifest operationId: PostEncodingManifestsDash description: A Custom DASH Manifest gives you full control over its contents. Add Periods, Adaptation Sets, Representations, Content Protections or Custom XML Elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Custom DASH Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/DashManifest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashManifest' - description: Id of the DASH Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/default: post: tags: - Manifests summary: Create Default DASH Manifest operationId: PostEncodingManifestsDashDefault description: A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Default DASH Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/DashManifestDefault' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashManifestDefault' - description: Id of the DASH Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/audio: post: tags: - Manifests summary: Add Audio AdaptationSet operationId: PostEncodingManifestsDashPeriodsAdaptationsetsAudioByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The audio adaptation set to be added to the period content: application/json: schema: $ref: '#/components/schemas/AudioAdaptationSet' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AudioAdaptationSet' - description: AudioAdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/contentprotection: post: tags: - Manifests summary: Add Content Protection to AdaptationSet operationId: PostEncodingManifestsDashPeriodsAdaptationsetsContentprotectionByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The content protection to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/ContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ContentProtection' - description: AdaptationSet Content Protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/image: post: tags: - Manifests summary: Add Image AdaptationSet operationId: PostEncodingManifestsDashPeriodsAdaptationsetsImageByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The image adaptation set to be added to the period content: application/json: schema: $ref: '#/components/schemas/ImageAdaptationSet' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ImageAdaptationSet' - description: ImageAdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/chunked-text: post: tags: - Manifests summary: Add Chunked Text Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsChunkedTextByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The Chunked Text Representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashChunkedTextRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashChunkedTextRepresentation' - description: Chunked Text Representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/cmaf: post: tags: - Manifests summary: Add CMAF Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsCmafByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The CMAF representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashCmafRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashCmafRepresentation' - description: CMAF representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/cmaf/{representation_id}/contentprotection : post: tags: - Manifests summary: Add Content Protection to CMAF Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsCmafContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d requestBody: description: The content protection to be added to the CMAF representation content: application/json: schema: $ref: '#/components/schemas/ContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ContentProtection' - description: Id of the DRM CMAF representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4: post: tags: - Manifests summary: Add fMP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4ByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The fMP4 representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashFmp4Representation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashFmp4Representation' - description: Fmp4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/{representation_id}/contentprotection : post: tags: - Manifests summary: Add Content Protection to fMP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4ContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d requestBody: description: The content protection to be added to the fMP4 representation content: application/json: schema: $ref: '#/components/schemas/ContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ContentProtection' - description: Id of the DRM Fmp4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/drm: post: tags: - Manifests summary: Add DRM fMP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4DrmByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The DRM fMP4 representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashFmp4DrmRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashFmp4DrmRepresentation' - description: Id of the DRM Fmp4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/fmp4/drm/{representation_id}/contentprotection : post: tags: - Manifests summary: Add Content Protection to DRM fMP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsFmp4DrmContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d requestBody: description: The content protection to be added to the DRM fMP4 representation content: application/json: schema: $ref: '#/components/schemas/ContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ContentProtection' - description: Id of the DRM Fmp4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/imsc: post: tags: - Manifests summary: Add IMSC Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsImscByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the subtitle adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: 'The IMSC representation to be added to the adaptation set. Note that the adaptation set has to be a subtitle adaptation set. ' content: application/json: schema: $ref: '#/components/schemas/DashImscRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashImscRepresentation' - description: Imsc representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/mp4: post: tags: - Manifests summary: Add MP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsMp4ByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The MP4 representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashMp4Representation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashMp4Representation' - description: MP4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/mp4/drm: post: tags: - Manifests summary: Add DRM MP4 Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsMp4DrmByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The DRM MP4 representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashMp4DrmRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashMp4DrmRepresentation' - description: Id of the DRM MP4 representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/progressive-webm : post: tags: - Manifests summary: Add Progressive WebM Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsProgressiveWebmByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The Progressive WebM representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashProgressiveWebmRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashProgressiveWebmRepresentation' - description: Progressive WebM representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/sprite: post: tags: - Manifests summary: Add Sprite Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsSpriteByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the image adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: 'The Sprite representation to be added to the adaptation set. Note that the adaptation set has to be an image adaptation set. Only supported for sprites generated with encoder version `2.76.0` or above. ' content: application/json: schema: $ref: '#/components/schemas/SpriteRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SpriteRepresentation' - description: Sprite representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/vtt: post: tags: - Manifests summary: Add VTT Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsVttByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The VTT representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashVttRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashVttRepresentation' - description: VTT representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/webm: post: tags: - Manifests summary: Add WebM Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsWebmByManifestIdAndPeriodIdAndAdaptationsetId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 requestBody: description: The WebM representation to be added to the adaptation set content: application/json: schema: $ref: '#/components/schemas/DashWebmRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/DashWebmRepresentation' - description: WebM representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' ? /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/{adaptationset_id}/representations/webm/{representation_id}/contentprotection : post: tags: - Manifests summary: Add Content Protection to WebM Representation operationId: PostEncodingManifestsDashPeriodsAdaptationsetsRepresentationsWebmContentprotectionByManifestIdAndPeriodIdAndAdaptationsetIdAndRepresentationId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: adaptationset_id in: path description: Id of the adaptation set style: simple required: true schema: type: string example: ae1c49de-9b7a-4b6f-9d0b-401d7d64e835 - name: representation_id in: path description: Id of the representation style: simple required: true schema: type: string example: 0695f80f-ad88-4051-b1b8-0d82d5f7192d requestBody: description: The content protection to be added to the WebM representation content: application/json: schema: $ref: '#/components/schemas/ContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ContentProtection' - description: Id of the DRM WebM representation default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/subtitle: post: tags: - Manifests summary: Add Subtitle AdaptationSet operationId: PostEncodingManifestsDashPeriodsAdaptationsetsSubtitleByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The subtitle adaptation set to be added to the period content: application/json: schema: $ref: '#/components/schemas/SubtitleAdaptationSet' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SubtitleAdaptationSet' - description: SubtitleAdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/adaptationsets/video: post: tags: - Manifests summary: Add Video AdaptationSet operationId: PostEncodingManifestsDashPeriodsAdaptationsetsVideoByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The video adaptation set to be added to the period content: application/json: schema: $ref: '#/components/schemas/VideoAdaptationSet' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/VideoAdaptationSet' - description: VideoAdaptationSet default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods: post: tags: - Manifests summary: Add Period operationId: PostEncodingManifestsDashPeriodsByManifestId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 requestBody: description: The Period to be added to the manifest content: application/json: schema: $ref: '#/components/schemas/Period' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Period' - description: Period default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/periods/{period_id}/custom-xml-elements: post: tags: - Manifests summary: Add Custom XML Element to Period operationId: PostEncodingManifestsDashPeriodsCustomXmlElementsByManifestIdAndPeriodId parameters: - name: manifest_id in: path description: Id of the manifest style: simple required: true schema: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 - name: period_id in: path description: Id of the period style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: Data of the custom XML element to be added to the period content: application/json: schema: $ref: '#/components/schemas/CustomXmlElement' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/CustomXmlElement' - description: Custom XML Element default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/start: post: tags: - Manifests summary: Start DASH manifest generation operationId: PostEncodingManifestsDashStartByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the DASH Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: Manifest Startup Options content: application/json: schema: $ref: '#/components/schemas/StartManifestRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/dash/{manifest_id}/stop: post: tags: - Manifests summary: Stop DASH manifest generation operationId: PostEncodingManifestsDashStopByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the DASH Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the DASH Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls: post: tags: - Manifests summary: Create Custom HLS Manifest operationId: PostEncodingManifestsHls description: A Custom HLS Manifest gives you full control over its contents. Add Variant Streams and Media elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Custom HLS Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/HlsManifest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/HlsManifest' - description: HLS manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/default: post: tags: - Manifests summary: Create Default HLS Manifest operationId: PostEncodingManifestsHlsDefault description: A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Default HLS Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/HlsManifestDefault' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/HlsManifestDefault' - description: HLS manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/audio: post: tags: - Manifests summary: Add Audio Media operationId: PostEncodingManifestsHlsMediaAudioByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Audio Media to be added content: application/json: schema: $ref: '#/components/schemas/AudioMediaInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AudioMediaInfo' - description: Audio media details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/closed-captions: post: tags: - Manifests summary: Add Closed Captions Media operationId: PostEncodingManifestsHlsMediaClosedCaptionsByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Closed Captions Media to be added content: application/json: schema: $ref: '#/components/schemas/ClosedCaptionsMediaInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/ClosedCaptionsMediaInfo' - description: Closed Captions media details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/{media_id}/custom-tags: post: tags: - Manifests summary: Add Custom Tag to a Audio Media or a Subtitle media operationId: PostEncodingManifestsHlsMediaCustomTagByManifestIdAndMediaId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: media_id in: path description: Id of the media. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 requestBody: description: The Custom Tag to be added content: application/json: schema: $ref: '#/components/schemas/CustomTag' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/CustomTag' - description: Custom Tag details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/subtitles: post: tags: - Manifests summary: Add Subtitles Media operationId: PostEncodingManifestsHlsMediaSubtitlesByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Subtitles Media to be added content: application/json: schema: $ref: '#/components/schemas/SubtitlesMediaInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SubtitlesMediaInfo' - description: Subtitles media details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/video: post: tags: - Manifests summary: Add Video Media operationId: PostEncodingManifestsHlsMediaVideoByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Video Media to be added content: application/json: schema: $ref: '#/components/schemas/VideoMediaInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/VideoMediaInfo' - description: Video media details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/media/vtt: post: tags: - Manifests summary: Add VTT Media operationId: PostEncodingManifestsHlsMediaVttByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The VTT Media to be added content: application/json: schema: $ref: '#/components/schemas/VttMediaInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/VttMediaInfo' - description: VTT media details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/start: post: tags: - Manifests summary: Start HLS manifest generation operationId: PostEncodingManifestsHlsStartByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the HLS Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: Manifest Startup Options content: application/json: schema: $ref: '#/components/schemas/StartManifestRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the HLS manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/stop: post: tags: - Manifests summary: Stop HLS manifest generation operationId: PostEncodingManifestsHlsStopByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the HLS Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the HLS Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams: post: tags: - Manifests summary: Add Variant Stream operationId: PostEncodingManifestsHlsStreamsByManifestId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Variant Stream to be added content: application/json: schema: $ref: '#/components/schemas/StreamInfo' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/StreamInfo' - description: Variant stream details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams/{stream_id}/custom-tags: post: tags: - Manifests summary: Add Custom Tag to Variant Stream operationId: PostEncodingManifestsHlsStreamsCustomTagByManifestIdAndStreamId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: stream_id in: path description: Id of the variant stream. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 requestBody: description: The Custom Tag to be added content: application/json: schema: $ref: '#/components/schemas/CustomTag' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/CustomTag' - description: Custom Tag details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/hls/{manifest_id}/streams/{stream_id}/iframe: post: tags: - Manifests summary: Add I-frame playlist to variant stream operationId: PostEncodingManifestsHlsStreamsIframeByManifestIdAndStreamId parameters: - name: manifest_id in: path description: Id of the hls manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 - name: stream_id in: path description: Id of the variant stream. style: simple required: true schema: type: string example: 6129e1fc-786a-471b-9a2b-b9b033842697 requestBody: description: The I-frame playlist to be added content: application/json: schema: $ref: '#/components/schemas/IFramePlaylist' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/IFramePlaylist' - description: Iframe-Playlist details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth: post: tags: - Manifests summary: Create Smooth Streaming Manifest operationId: PostEncodingManifestsSmooth description: A Custom Smooth Streaming Manifest gives you full control over its contents. Add Representations and Content Protections via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Custom Smooth Streaming Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/SmoothStreamingManifest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SmoothStreamingManifest' - description: Smooth Streaming manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/contentprotection: post: tags: - Manifests summary: Add Content Protection to Smooth Streaming operationId: PostEncodingManifestsSmoothContentprotectionByManifestId parameters: - name: manifest_id in: path description: Id of the Smooth Streaming manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The Content Protection to be added content: application/json: schema: $ref: '#/components/schemas/SmoothManifestContentProtection' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SmoothManifestContentProtection' - description: Content protection default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/default: post: tags: - Manifests summary: Create Default Smooth Streaming Manifest operationId: PostEncodingManifestsSmoothDefault description: A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison requestBody: description: The Default Smooth Streaming Manifest to be created. content: application/json: schema: $ref: '#/components/schemas/SmoothManifestDefault' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SmoothManifestDefault' - description: Smooth Streaming Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/representations/mp4: post: tags: - Manifests summary: Add MP4 Representation to Smooth Streaming Manifest operationId: PostEncodingManifestsSmoothRepresentationsMp4ByManifestId parameters: - name: manifest_id in: path description: Id of the Smooth Streaming manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The MP4 Representation to be added content: application/json: schema: $ref: '#/components/schemas/SmoothStreamingRepresentation' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SmoothStreamingRepresentation' - description: Smooth Streaming manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/start: post: tags: - Manifests summary: Start Smooth Streaming manifest generation operationId: PostEncodingManifestsSmoothStartByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the Smooth Streaming Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: Manifest Startup Options content: application/json: schema: $ref: '#/components/schemas/StartManifestRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/manifests/smooth/{manifest_id}/stop: post: tags: - Manifests summary: Stop Smooth Streaming manifest generation operationId: PostEncodingManifestsSmoothStopByManifestId x-bitmovin: isRpc: true optionalRequestBody: true parameters: - name: manifest_id in: path description: Id of the Smooth Streaming Manifest. style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the Smooth Streaming Manifest default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/akamai-msl: post: tags: - Outputs summary: Create Akamai MSL Output operationId: PostEncodingOutputsAkamaiMsl requestBody: description: The Akamai MSL output to be created content: application/json: schema: $ref: '#/components/schemas/AkamaiMslOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiMslOutput' - description: Akamai MSL output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/akamai-netstorage: post: tags: - Outputs summary: Create Akamai NetStorage Output operationId: PostEncodingOutputsAkamaiNetStorage requestBody: description: The Akamai NetStorage output to be created content: application/json: schema: $ref: '#/components/schemas/AkamaiNetStorageOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AkamaiNetStorageOutput' - description: Akamai NetStorage output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/azure: post: tags: - Outputs summary: Create Azure Output operationId: PostEncodingOutputsAzure requestBody: description: The Azure output to be created content: application/json: schema: $ref: '#/components/schemas/AzureOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/AzureOutput' - description: Azure output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/{output_id}/check-permissions: post: tags: - Outputs summary: Check output permissions (S3 only) operationId: PostEncodingOutputsCheckPermissionsByOutputId x-bitmovin: isRpc: true operationName: checkPermissions optionalRequestBody: true parameters: - name: output_id in: path description: Id of the output to be checked. Currently limited to S3 outputs. The access credentials that have been provided for this Output still need to be valid, otherwise the request will fail. If they are not valid any more, create a new Output with new credentials (resources are immutable). style: simple required: true schema: type: string example: 4ae91f43-e78b-44c4-a9e3-890001c4bd07 requestBody: description: Additional parameters for the permissions check content: application/json: schema: $ref: '#/components/schemas/CheckOutputPermissionsRequest' responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/CheckOutputPermissionsResponse' - description: Permissions check result default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/ftp: post: tags: - Outputs summary: Create FTP Output operationId: PostEncodingOutputsFtp requestBody: description: The FTP output to be created content: application/json: schema: $ref: '#/components/schemas/FtpOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/FtpOutput' - description: FTP output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/gcs: post: tags: - Outputs summary: Create GCS Output operationId: PostEncodingOutputsGcs requestBody: description: The GCS output to be created content: application/json: schema: $ref: '#/components/schemas/GcsOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsOutput' - description: GCS output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/gcs-service-account: post: tags: - Outputs summary: Create Service Account based GCS Output operationId: PostEncodingOutputsGcsServiceAccount requestBody: description: The GCS output to be created content: application/json: schema: $ref: '#/components/schemas/GcsServiceAccountOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GcsServiceAccountOutput' - description: GCS output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/generic-s3: post: tags: - Outputs summary: Create Generic S3 Output operationId: PostEncodingOutputsGenericS3 requestBody: description: The Generic S3 output to be created content: application/json: schema: $ref: '#/components/schemas/GenericS3Output' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/GenericS3Output' - description: Generic S3 output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/live-media-ingest: post: tags: - Outputs summary: Create Live Media Ingest Output operationId: PostEncodingOutputsLiveMediaIngest requestBody: description: The Live Media Ingest output to be created content: application/json: schema: $ref: '#/components/schemas/LiveMediaIngestOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/LiveMediaIngestOutput' - description: Live Media Ingest output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/local: post: tags: - Outputs summary: Create Local Output operationId: PostEncodingOutputsLocal requestBody: description: The Local output to be created content: application/json: schema: $ref: '#/components/schemas/LocalOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/LocalOutput' - description: Local output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/s3: post: tags: - Outputs summary: Create S3 Output operationId: PostEncodingOutputsS3 requestBody: description: "The S3 output to be created\n\nThe following permissions are\ \ required for S3 output:\n * s3:PutObject\n * s3:PutObjectAcl\n * s3:ListBucket\n\ \ * s3:GetBucketLocation\n" content: application/json: schema: $ref: '#/components/schemas/S3Output' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/S3Output' - description: S3 output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/s3-role-based: post: tags: - Outputs summary: Create S3 Role-based Output operationId: PostEncodingOutputsS3RoleBased requestBody: description: "The S3 Role-based output to be created\n\nThe following permissions\ \ are required for S3 Role-based output:\n * s3:PutObject\n * s3:PutObjectAcl\n\ \ * s3:ListBucket\n * s3:GetBucketLocation\n" content: application/json: schema: $ref: '#/components/schemas/S3RoleBasedOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/S3RoleBasedOutput' - description: S3 Role-based Output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/outputs/sftp: post: tags: - Outputs summary: Create SFTP Output operationId: PostEncodingOutputsSftp requestBody: description: The SFTP output to be created. content: application/json: schema: $ref: '#/components/schemas/SftpOutput' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/SftpOutput' - description: SFTP output default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/templates: post: tags: - Templates summary: Store an Encoding Template operationId: PostEncodingTemplates description: 'Stores an Encoding Template that can be used later to start encodings or standby pools ' requestBody: description: The Encoding Template to be stored content: application/json: schema: $ref: '#/components/schemas/EncodingTemplateRequest' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EncodingTemplateDetails' - description: Stored Encoding Template info default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/templates/start: post: tags: - Templates summary: Start an Encoding defined with an Encoding Template operationId: PostEncodingTemplatesStart x-bitmovin: isRpc: true requestBody: description: The Encoding Template to start an Encoding from content: application/json: schema: $ref: '#/components/schemas/EncodingTemplateRequest' required: true responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EncodingTemplateStartResponse' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/standby-pools/{pool_id}/actions/delete-error-encodings: post: tags: - Live summary: Delete error encodings from the standby pool operationId: PostLiveStandbyPoolsActionsDeleteErrorEncodings x-bitmovin: isRpc: true operationName: deleteErrorEncodings optionalRequestBody: true parameters: - name: pool_id in: path description: Id of the standby pool style: simple required: true schema: type: string example: e421d5ca-ef52-46b5-9344-efd229ff5129 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/LiveStandbyPoolEncoding' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/error: post: tags: - Emails summary: Add Encoding Error Email Notification (All Encodings) operationId: PostNotificationsEmailsEncodingEncodingsError requestBody: description: Add a new email notification if an encoding received an error content: application/json: schema: $ref: '#/components/schemas/EncodingErrorEmailNotification' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/PaginationResponse' - properties: items: description: Notification Details items: $ref: '#/components/schemas/EncodingErrorEmailNotification' default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/{encoding_id}/error: post: tags: - Emails summary: Add Encoding Error Email Notification (Specific Encoding) operationId: PostNotificationsEmailsEncodingEncodingsErrorByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: The email notifications object content: application/json: schema: $ref: '#/components/schemas/EmailNotification' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EmailNotification' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/live-input-stream-changed: post: tags: - Emails summary: Add Live Input Stream Changed Email Notification (All Encodings) operationId: PostNotificationsEmailsEncodingEncodingsLiveInputStreamChanged requestBody: description: The email notifications object content: application/json: schema: $ref: '#/components/schemas/EmailNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EmailNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/{encoding_id}/live-input-stream-changed: post: tags: - Emails summary: Add Live Input Stream Changed Email Notification (Specific Encoding) operationId: PostNotificationsEmailsEncodingEncodingsLiveInputStreamChangedByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: The email notifications object content: application/json: schema: $ref: '#/components/schemas/EmailNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EmailNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/{notification_id}/mute: post: tags: - Notifications summary: Mute Notification operationId: PostNotificationsMuteByNotificationId x-bitmovin: isRpc: true parameters: - name: notification_id in: path description: Id of the notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the notification default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/{notification_id}/unmute: post: tags: - Notifications summary: Unmute Notification operationId: PostNotificationsUnmuteByNotificationId x-bitmovin: isRpc: true parameters: - name: notification_id in: path description: Id of the notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/BitmovinResponse' - description: Id of the notification default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/{manifest_id}/error: post: tags: - Webhooks summary: Add 'Manifest Error' Webhook Notification (Specific Manifest) operationId: PostNotificationsWebhookManifestErrorByEncodingId x-bitmovin: operationName: createByManifestId parameters: - name: manifest_id in: path description: Id of the manifest resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: The webhook notifications object. A maximum number of 5 webhooks per Manifest is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/{manifest_id}/finished: post: tags: - Webhooks summary: Add 'Manifest Finished Successfully' Webhook Notification (Specific Manifest) operationId: PostNotificationsWebhookManifestFinishedByEncodingId x-bitmovin: operationName: createByManifestId parameters: - name: manifest_id in: path description: Id of the manifest resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: The webhook notifications object. A maximum number of 5 webhooks per Manifest is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/error: post: tags: - Webhooks summary: Add 'Manifest Error' Webhook (All Manifests) operationId: PostNotificationsWebhookManifestsError description: Add a new webhook notification that triggers if a manifest generation fails. A maximum number of 5 webhooks is allowed requestBody: description: The 'Manifest Error' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/finished: post: tags: - Webhooks summary: Add 'Manifest Finished Successfully' Webhook (All Manifests) operationId: PostNotificationsWebhookManifestsFinished requestBody: description: Add a new webhook notification that triggers if a manifest generation finished successfully. A maximum number of 5 webhooks is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/encoding-status-changed: post: tags: - Webhooks summary: Add Encoding Changed Webhook Notification (Specific Encoding) operationId: PostNotificationsWebhooksEncodingEncodingsEncodingStatusChangedByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: 'The webhook notifications object. For conditions, following attributes are possible: ''type'': ''Input file download'', ''Input file analysis'', ''Per-Title analysis'', ''Encoding'', ''Progressive Muxing'' ''progress'': number in range of 0-100 ''status'': ''RUNNING'', ''FINISHED'', ''ERROR'' Examples: To only get notified about the encoding process, create a Condition object and set attribute=''type'', value=''Encoding'', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute=''status'', value=''FINISHED'', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute=''progress'', value=''50'', operator=GREATER_THAN ' content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/error: post: tags: - Webhooks summary: Add 'Encoding Error' Webhook operationId: PostNotificationsWebhooksEncodingEncodingsError description: Add a new webhook notification that triggers if an encoding fails. A maximum number of 5 webhooks is allowed requestBody: description: The 'Encoding Error' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/error: post: tags: - Webhooks summary: Add Error Webhook for a specific Encoding operationId: PostNotificationsWebhooksEncodingEncodingsErrorByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: 23627cb2-7228-45ed-91fa-489bf5e20fe3 requestBody: description: The 'Encoding Error' Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/finished: post: tags: - Webhooks summary: Add 'Encoding Finished' Webhook description: Add a new webhook notification that triggers if an encoding finishes successfully. A maximum number of 5 webhooks is allowed operationId: PostNotificationsWebhooksEncodingEncodingsFinished requestBody: description: The 'Encoding Finished' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/finished: post: tags: - Webhooks summary: Add 'Encoding Finished' Webhook for a specific Encoding operationId: PostNotificationsWebhooksEncodingEncodingsFinishedByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: 23627cb2-7228-45ed-91fa-489bf5e20fe3 requestBody: description: The 'Encoding Finished' Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/live-encoding-heartbeat: post: tags: - Webhooks summary: Add 'Live Encoding Heartbeat' Webhook description: 'Add a new webhook notification that triggers a heartbeat webhook with a fixed `interval` for all Live Encodings. ' operationId: PostNotificationsWebhooksEncodingEncodingsLiveEncodingHeartbeat requestBody: description: The 'Live Encoding Heartbeat' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/LiveEncodingHeartbeatWebhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/LiveEncodingHeartbeatWebhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/live-input-stream-changed: post: tags: - Webhooks summary: Add Live Input Stream Changed Webhook Notification (All Encodings) operationId: PostNotificationsWebhooksEncodingEncodingsLiveInputStreamChanged requestBody: description: The webhook notifications object content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/live-input-stream-changed: post: tags: - Webhooks summary: Add Live Input Stream Changed Webhook Notification (Specific Encoding) operationId: PostNotificationsWebhooksEncodingEncodingsLiveInputStreamChangedByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding resource style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-bd20-1dee353d8a72 requestBody: description: The webhook notifications object content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/live-manifest-ready: post: tags: - Webhooks summary: Add 'Live Manifest Ready' Webhook description: Add a webhook notification that is triggered when a live manifest is ready, meaning at least one segment is available in every playlist. A maximum number of 5 webhooks is allowed operationId: PostNotificationsWebhooksEncodingEncodingsLiveManifestReady requestBody: description: The 'Live Manifest Ready' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '201': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/live-manifest-ready: post: tags: - Webhooks summary: Add 'Live Manifest Ready' Webhook for a specific Encoding description: Add a new webhook notification that triggers when a live manifest is ready for a specific encoding. A maximum number of 5 webhooks per Encoding is allowed operationId: PostNotificationsWebhooksEncodingEncodingsLiveManifestReadyByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: 23627cb2-7228-45ed-91fa-489bf5e20fe3 requestBody: description: The 'Live Manifest Ready' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/encoding-status-changed: post: tags: - Webhooks summary: Add Encoding Changed Webhook Notification (All Encodings) operationId: PostNotificationsWebhooksEncodingEncodingsStatusChanged requestBody: description: 'The webhook notifications object. For conditions, following attributes are possible: ''type'': ''Input file download'', ''Input file analysis'', ''Per-Title analysis'', ''Encoding'', ''Progressive Muxing'' ''progress'': number in range of 0-100 ''status'': ''RUNNING'', ''FINISHED'', ''ERROR'' Examples: To only get notified about the encoding process, create a Condition object and set attribute=''type'', value=''Encoding'', operator=EQUAL To only get notified if a workflow step is finished, create a Condition object and set attribute=''status'', value=''FINISHED'', operator=EQUAL To only get notified if a workflow step is over 50%, create a Condition object and set attribute=''progress'', value=''50'', operator=GREATER_THAN' content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/transfer-error: post: tags: - Webhooks summary: Add 'Encoding Transfer Error' Webhook description: Add a new webhook notification that triggers if a transfer fails. A maximum number of 5 webhooks is allowed operationId: PostNotificationsWebhooksEncodingEncodingsTransferError requestBody: description: The 'Encoding Transfer Error' Webhook to be added. content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/{encoding_id}/transfer-error: post: tags: - Webhooks summary: Add 'Encoding Transfer Error' Webhook for a specific Encoding operationId: PostNotificationsWebhooksEncodingEncodingsTransferErrorByEncodingId x-bitmovin: operationName: createByEncodingId parameters: - name: encoding_id in: path description: Id of the encoding style: simple required: true schema: type: string example: 23627cb2-7228-45ed-91fa-489bf5e20fe3 requestBody: description: The 'Encoding Transfer Error' Webhook to be added. A maximum number of 5 webhooks per Encoding is allowed content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Webhook Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/error/{notification_id}: put: tags: - Emails summary: Replace Encoding Error Email Notification operationId: PutNotificationsEmailsEncodingEncodingsErrorByNotificationId parameters: - name: notification_id in: path description: Id of the email notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The email notification with the updated values content: application/json: schema: $ref: '#/components/schemas/EmailNotification' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EmailNotification' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/emails/encoding/encodings/live-input-stream-changed/{notification_id}: put: tags: - Emails summary: Replace Live Input Stream Changed Email Notification operationId: PutNotificationsEmailsEncodingEncodingsLiveInputStreamChangedByInputId parameters: - name: notification_id in: path description: Id of the email notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The email notification with the updated values content: application/json: schema: $ref: '#/components/schemas/EmailNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/EmailNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/error/{notification_id}: put: tags: - Webhooks summary: Replace 'Manifest Error' Webhook Notification operationId: PutNotificationsWebhookManifestErrorByNotificationId parameters: - name: notification_id in: path description: Id of the webhook notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The webhook notification with the updated values content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/manifest/finished/{notification_id}: put: tags: - Webhooks summary: Replace Manifest Finished Webhook Notification operationId: PutNotificationsWebhookManifestFinishedByNotificationId parameters: - name: notification_id in: path description: Id of the webhook notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The webhook notification with the updated values content: application/json: schema: $ref: '#/components/schemas/Webhook' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/Webhook' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/encoding-status-changed/{notification_id}: put: tags: - Webhooks summary: Replace Encoding Status Changed Webhook Notification operationId: PutNotificationsWebhooksEncodingEncodingsEncodingStatusChangedByInputId parameters: - name: notification_id in: path description: Id of the webhook notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The webhook notification with the updated values content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /notifications/webhooks/encoding/encodings/live-input-stream-changed/{notification_id}: put: tags: - Webhooks summary: Replace Live Input Stream Changed Webhook Notification operationId: PutNotificationsWebhooksEncodingEncodingsLiveInputStreamChangedByInputId parameters: - name: notification_id in: path description: Id of the webhook notification style: simple required: true schema: type: string example: cb90b80c-8867-4e3b-8479-174aa2843f62 requestBody: description: The webhook notification with the updated values content: application/json: schema: $ref: '#/components/schemas/WebhookNotificationWithStreamConditionsRequest' responses: '202': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: allOf: - $ref: '#/components/schemas/WebhookNotificationWithStreamConditions' - description: Notification Details default: description: Error response. content: application/json: schema: $ref: '#/components/schemas/ResponseError' /encoding/live/encodings/{encoding_id}/actions/update-rtmp-ingest-points: patch: tags: - Live summary: Update the ingest points of a Redundant RTMP Input operationId: UpdateRTMPIngestPoints x-bitmovin: isRpc: true operationName: patch optionalRequestBody: false parameters: - name: encoding_id in: path description: Id of the encoding. style: simple required: true schema: type: string example: f3177c2e-0000-4ba6-a492-4fc5fdc35701 requestBody: required: true description: The list of the RTMP ingest points to update. content: application/json: schema: $ref: '#/components/schemas/UpdateEncodingRtmpIngestPointRequest' responses: '200': description: Successful response. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - properties: data: properties: result: $ref: '#/components/schemas/UpdateEncodingRtmpIngestPointResponse' 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: BitmovinResponse: title: BitmovinResponse required: - id properties: id: type: string readOnly: true description: Id of the resource example: cb90b80c-8867-4e3b-8479-174aa2843f62 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 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 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 readOnly: true description: 'Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes ' 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 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 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 Drm: title: Drm required: - outputs allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: outputs: type: array items: $ref: '#/components/schemas/EncodingOutput' 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' MarlinDrm: title: MarlinDrm required: - key - kid allOf: - $ref: '#/components/schemas/Drm' - properties: key: writeOnly: true type: string description: 16 byte key in hex (32 characters) example: 123456789ABCDEF123456789ABCDEF12 kid: type: string description: 16 byte key in hex (32 characters) example: 123456789ABCDEF123456789ABCDEF12 BitmovinResponseList: type: array items: $ref: '#/components/schemas/BitmovinResponse' AkamaiAccount: title: AkamaiAccount required: - name - apiToken allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: apiToken: type: string description: Akamai/Linode API token example: d182edb2758064d0430654db4be0cf335cbd4ac26b75e7d75cf6b989a87d1e55 writeOnly: true AkamaiAccountRegionSettings: title: AkamaiAccountRegionSettings required: - subnetId - firewallId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: subnetId: type: integer format: int64 description: Id of the VPC subnet for encoding instances example: 123456 firewallId: type: integer format: int64 description: Id of the firewall for encoding instances example: 123456 region: readOnly: true allOf: - $ref: '#/components/schemas/AkamaiCloudRegion' AkamaiCloudRegion: title: AkamaiCloudRegion type: string enum: - BR_GRU - ES_MAD - FR_PAR - ID_CGK - IN_MAA - IT_MIL - JP_OSA - NL_AMS - SE_STO - US_LAX - US_MIA - US_ORD - US_SEA x-enum-elements: - name: BR_GRU description: São Paulo, Brazil - name: ES_MAD description: Madrid, Spain - name: FR_PAR description: Paris, France - name: ID_CGK description: Jakarta, Indonesia - name: IN_MAA description: Chennai, India - name: IT_MIL description: Milan, Italy - name: JP_OSA description: Osaka, Japan - name: NL_AMS description: Amsterdam, Netherlands - name: SE_STO description: Stockholm, Sweden - name: US_LAX description: Los Angeles, USA - name: US_MIA description: Miami, USA - name: US_ORD description: Chicago, USA - name: US_SEA description: Seattle, USA AwsAccount: title: AwsAccount required: - accountNumber oneOf: - required: - accessKey - secretKey - required: - roleName allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: accessKey: type: string description: 'Deprecated: Amazon access key for legacy support. Use `roleName` instead' example: AKIAIOSFODNN7EXAMPLE writeOnly: true deprecated: true secretKey: type: string description: 'Deprecated: Amazon secret key for legacy support. Use `roleName` instead' example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY writeOnly: true deprecated: true accountNumber: type: string description: Amazon account number (12 digits as per AWS spec) example: 123456789012 writeOnly: true roleName: type: string description: 'Role name including path for the AWS IAM role that will be used by Bitmovin to access the AWS account depicted by `accountNumber`. The role ARN is constructed based on `accountNumber` and `roleName`: `arn:aws:iam::{accountNumber}:role/{roleName}`. For details on how to create the AWS IAM role in your account, please refer to the [AWS cloud connect setup guide](https://developer.bitmovin.com/encoding/docs/using-bitmovin-cloud-connect-with-aws). ' example: bitmovin-encoder externalId: type: string description: External ID that needs to be set in the trust policy of the AWS IAM role (depicted by `roleName`) that allows Bitmovin access to the AWS account depicted by `accountNumber` example: cb90b80c-8867-4e3b-8479-174aa2843f62 readOnly: true AwsAccountRegionSettings: title: AwsAccountRegionSettings required: - securityGroupId - subnetId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: limitParallelEncodings: type: integer format: int64 description: Limit for the amount of running encodings at a time. Leave empty for no limit. example: 10 securityGroupId: type: string description: Id of the security group for encoding instances example: sg-0f3a444c subnetId: type: string description: Id of the subnet for encoding instances example: subnet-d3f100b2 sshPort: type: integer minimum: 1 maximum: 65535 description: 'Custom SSH port. Valid values: 1 - 65535. Leave empty if the default SSH port 22 is OK.' example: 9073 region: allOf: - $ref: '#/components/schemas/AwsCloudRegion' readOnly: true AwsCloudRegion: title: AwsCloudRegion type: string enum: - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - EU_WEST_1 - EU_CENTRAL_1 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_SOUTH_1 - SA_EAST_1 - EU_WEST_2 - EU_WEST_3 - CA_CENTRAL_1 - EU_NORTH_1 x-enum-elements: - name: US_EAST_1 description: US East (N. Virginia) - name: US_EAST_2 description: US East (Ohio) - name: US_WEST_1 description: US West (N. California) - name: US_WEST_2 description: US West (Oregon) - name: EU_WEST_1 description: Europe (Ireland) - name: EU_CENTRAL_1 description: Europe (Frankfurt) - name: AP_SOUTHEAST_1 description: Asia Pacific (Singapore) - name: AP_SOUTHEAST_2 description: Asia Pacific (Sydney) - name: AP_NORTHEAST_1 description: Asia Pacific (Tokyo) - name: AP_NORTHEAST_2 description: Asia Pacific (Seoul) - name: AP_SOUTH_1 description: Asia Pacific (Mumbai) - name: SA_EAST_1 description: South America (São Paulo) - name: EU_WEST_2 description: Europe (London) - name: EU_WEST_3 description: Europe (Paris) - name: CA_CENTRAL_1 description: Canada (Central) - name: EU_NORTH_1 description: Europe (Stockholm) AzureAccount: title: AzureAccount required: - subscriptionId - resourceGroupId - tenantId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: subscriptionId: type: string description: Your Azure Subscription ID (The ID of your subscription where you intend to run the Encoding VMs) example: 6e934bc4-b7d5-42e3-bbe0-c78e062b80c9 resourceGroupId: type: string description: The name of the resource group where you intend to run the Encoding VMs example: encodingGroup tenantId: type: string description: The ID of your Active Directory where your subscription runs in example: 2eb829b4-4dd3-4fb3-b3a5-aec895b06bd3 AzureAccountRegionSettings: title: AzureAccountRegionSettings required: - networkName - subnetName allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: networkName: type: string description: Name of the virtual network subnetName: type: string description: Name of the subnet example: encodingSubnet region: allOf: - $ref: '#/components/schemas/AzureCloudRegion' readOnly: true AzureCloudRegion: title: AzureCloudRegion type: string enum: - ASIA_EAST - ASIA_SOUTHEAST - AUSTRALIA_EAST - AUSTRALIA_SOUTHEAST - BRAZIL_SOUTH - CANADA_CENTRAL - EUROPE_NORTH - EUROPE_WEST - FRANCE_CENTRAL - GERMANY_WESTCENTRAL - INDIA_CENTRAL - INDIA_SOUTH - JAPAN_EAST - JAPAN_WEST - KOREA_CENTRAL - UAE_NORTH - US_CENTRAL - US_EAST - US_EAST2 - US_WEST - US_WEST2 - US_SOUTH_CENTRAL - US_NORTH_CENTRAL - UK_SOUTH x-enum-elements: - name: ASIA_EAST description: Hong Kong - name: ASIA_SOUTHEAST description: Singapore - name: AUSTRALIA_EAST description: New South Wales - name: AUSTRALIA_SOUTHEAST description: Victoria - name: BRAZIL_SOUTH description: São Paulo - name: CANADA_CENTRAL description: Toronto - name: EUROPE_NORTH description: Ireland - name: EUROPE_WEST description: Netherlands - name: FRANCE_CENTRAL description: Paris - name: GERMANY_WESTCENTRAL description: Frankfurt - name: INDIA_CENTRAL description: Pune - name: INDIA_SOUTH description: Chennai - name: JAPAN_EAST description: Tokyo, Saitama - name: JAPAN_WEST description: Osaka - name: KOREA_CENTRAL description: Seoul - name: UAE_NORTH description: Dubai - name: US_CENTRAL description: Iowa - name: US_EAST description: Virginia - name: US_EAST2 description: Virginia - name: US_WEST description: California - name: US_WEST2 description: Washington - name: US_SOUTH_CENTRAL description: Texas - name: US_NORTH_CENTRAL description: Illinois - name: UK_SOUTH description: London GceAccount: title: GceAccount description: 'GCE Cloud Connect Account. Configure either by passing a single service account credentials JSON string or by passing the service account email, private key and project ID individually. ' anyOf: - required: - name - serviceAccountCredentials - required: - name - serviceAccountEmail - privateKey - projectId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: serviceAccountCredentials: type: string description: GCP service account credentials JSON example: "{\n \"type\": \"service_account\",\n \"project_id\": \"bitmovin\"\ ,\n \"private_key_id\": \"dfgsgfdsgsgargdf\",\n \"private_key\": \"\ -----BEGIN PRIVATE KEY-----\\nOwdXyjRT9F4A==\\n-----END PRIVATE KEY-----\\\ n\",\n \"client_email\": \"bitmovin@bitmovin.iam.gserviceaccount.com\"\ ,\n \"client_id\": \"10440564562784234997\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\"\ ,\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\"\ : \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\"\ : \"https://www.googleapis.com/robot/v1/metadata/x509/bitmovin%40bitmovin.iam.gserviceaccount.com\"\ \n}\n" writeOnly: true serviceAccountEmail: type: string description: Email address of the Google service account that will be used to spin up VMs example: bitmovin-connect-account@my-gcp-project.iam.gserviceaccount.com privateKey: type: string description: Google private key of the Google service account that will be used to spin up VMs example: '-----BEGIN PRIVATE KEY----- Loads Of Stuff Thats All Secret -----END PRIVATE KEY----- ' writeOnly: true projectId: type: string description: ID of the GCP project in which the VMs are supposed to run. example: my-gcp-project GceAccountRegionSettings: title: GceAccountRegionSettings required: - network - subnetId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: network: type: string description: Id of the network for encoding instances example: /global/networks/custom-vpc subnetId: type: string description: Id of the subnet for encoding instances example: /regions/europe-west1/subnetworks/custom-subnet-euw1 region: readOnly: true allOf: - $ref: '#/components/schemas/GoogleCloudRegion' GoogleCloudRegion: title: GoogleCloudRegion type: string enum: - US_CENTRAL_1 - US_EAST_1 - ASIA_EAST_1 - EUROPE_WEST_1 - US_WEST_1 - ASIA_EAST_2 - ASIA_NORTHEAST_1 - ASIA_SOUTH_1 - ASIA_SOUTHEAST_1 - AUSTRALIA_SOUTHEAST_1 - EUROPE_NORTH_1 - EUROPE_WEST_2 - EUROPE_WEST_3 - EUROPE_WEST_4 - NORTHAMERICA_NORTHEAST_1 - SOUTHAMERICA_EAST_1 - US_EAST_4 - US_WEST_2 - ME_CENTRAL_2 x-enum-elements: - name: US_CENTRAL_1 description: Council Bluffs, Iowa, USA - name: US_EAST_1 description: Moncks Corner, South Carolina, USA - name: ASIA_EAST_1 description: Changhua County, Taiwan - name: EUROPE_WEST_1 description: St. Ghislain, Belgium - name: US_WEST_1 description: The Dalles, Oregon, USA - name: ASIA_EAST_2 description: Hong Kong - name: ASIA_NORTHEAST_1 description: Tokyo, Japan - name: ASIA_SOUTH_1 description: Mumbai, India - name: ASIA_SOUTHEAST_1 description: Jurong West, Singapore - name: AUSTRALIA_SOUTHEAST_1 description: Sydney, Australia - name: EUROPE_NORTH_1 description: Hamina, Finland - name: EUROPE_WEST_2 description: London, England, UK - name: EUROPE_WEST_3 description: Frankfurt, Germany - name: EUROPE_WEST_4 description: Eemshaven, Netherlands - name: NORTHAMERICA_NORTHEAST_1 description: Montréal, Québec, Canada - name: SOUTHAMERICA_EAST_1 description: São Paulo, Brazil - name: US_EAST_4 description: Ashburn, Northern Virginia, USA - name: US_WEST_2 description: Los Angeles, California, USA - name: ME_CENTRAL_2 description: Dammam, Saudi Arabia OciAccount: title: OciAccount required: - name - tenancyId - compartmentId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: tenancyId: type: string description: The OCID of the tenancy where you intend to run encoding VMs. example: ocid1.tenancy.oc1..aaaaaaa62m3xkqtfvbhnb2p4d7lgj5zyrsw5b7qxssmaohjeyvhucldfupa compartmentId: type: string description: The OCID of the compartment within the tenancy where you intend to run encoding VMs. example: ocid1.compartment.oc1..aaaaaaaofg6zqtn3v5yxlk2jhdmb74sypcxwu2d7zvqajbeirmfu3p5dfua OciAccountRegionSettings: title: OciAccountRegionSettings required: - subnetId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: subnetId: type: string description: Id of the VPC subnet for encoding instances. example: ocid1.subnet.oc1.eu-frankfurt-1.aaaaaaaqb3xztomfv7ylk25jhdwsu4syvtcmwv2d2vaqajvinngfilp5pfua region: description: Region for encoding instances. readOnly: true allOf: - $ref: '#/components/schemas/OciCloudRegion' OciCloudRegion: title: OciCloudRegion type: string enum: - EU_FRANKFURT_1 - US_ASHBURN_1 x-enum-elements: - name: EU_FRANKFURT_1 description: Frankfurt, Germany - name: US_ASHBURN_1 description: Ashburn, Virginia, USA AkamaiNetStorageInput: title: AkamaiNetStorageInput required: - host - username - password allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string description: Host to use for Akamai NetStorage transfers example: youraccount.akamaihd.net username: type: string description: Your Akamai NetStorage Username example: encodingInputUser writeOnly: true password: type: string description: Your Akamai NetStorage password example: myUncrackablePassword writeOnly: true Input: title: Input allOf: - $ref: '#/components/schemas/BitmovinResource' AsperaInput: title: AsperaInput required: - host allOf: - $ref: '#/components/schemas/Input' - properties: minBandwidth: type: string description: 'Minimal download bandwidth. Examples: 100k, 100m, 100g' example: 100k maxBandwidth: type: string description: 'Maximal download bandwidth. Examples: 100k, 100m, 100g' example: 100k host: type: string description: Host to use for Aspera transfers example: AsperaHost.com username: type: string description: Username to log into Aspera host (either password and user must be set or token) example: encodingInputUser writeOnly: true password: type: string description: corresponding password (either password and user must be set or token) example: 3nc0d3d! writeOnly: true token: type: string description: Token used for authentication (either password and user must be set or token) example: token writeOnly: true sshPort: type: integer description: Set the TCP port to be used for fasp session initiation default: 22 faspPort: type: integer description: Set the UDP port to be used by fasp for data transfer default: 33001 AzureInput: title: AzureInput required: - container - accountName oneOf: - title: Authenticate with Entra ID Service Principal required: - servicePrincipal - title: Authenticate with Account Key required: - accountKey allOf: - $ref: '#/components/schemas/Input' - properties: accountName: type: string description: Azure Account Name example: devstoreaccount1 writeOnly: true accountKey: type: string description: Azure Account Key example: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw== writeOnly: true deprecated: true servicePrincipal: allOf: - $ref: '#/components/schemas/AzureServicePrincipal' container: type: string description: Name of the bucket example: video-container AzureServicePrincipal: title: AzureServicePrincipal type: object description: Azure service principal credentials for Microsoft Entra ID authentication. This authentication method is usable from encoder version 2.273.0 onwards. required: - tenantId - clientId oneOf: - title: Authenticate with Client Secret required: - clientSecret - title: Authenticate with Client Certificate required: - clientCertificate allOf: - properties: tenantId: type: string description: Tenant ID (Directory ID) of the Azure service principal writeOnly: true clientId: type: string description: Client ID of the Azure service principal writeOnly: true clientSecret: type: string description: Client secret of the Azure service principal writeOnly: true clientCertificate: type: string description: PEM-encoded client certificate and private key of the Azure service principal. Newline symbols must be preserved. example: '-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDAMn/1SpomwntO ... (truncated) ... Qu6eQUtTE/RCuArarGuOtE0= -----END PRIVATE KEY----- -----BEGIN CERTIFICATE----- MIIDDTCCAfWgAwIBAgIUX5jXOu6RNVC5MAfi9L/PiIhADMQwDQYJKoZIhvcNAQEL ... (truncated) ... 28mdG3XdDAQfClkhhArMktQ= -----END CERTIFICATE----- ' writeOnly: true FtpInput: title: FtpInput required: - host allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string description: Host URL or IP of the FTP server example: bitmovin.com port: type: integer description: 'Port to use, standard for FTP: 21' example: 21 passive: type: boolean description: Use passive mode. Default is true. example: true username: type: string description: Your FTP Username example: encodingInputUser writeOnly: true password: type: string description: Your FTP password example: 3nc0d3d! writeOnly: true remoteVerificationEnabled: type: boolean description: Ensure that connections originate from the declared ftp host. Default is true. example: false GcsInput: title: GcsInput required: - bucketName - accessKey - secretKey allOf: - $ref: '#/components/schemas/Input' - properties: bucketName: type: string description: Name of the bucket example: video-bucket cloudRegion: description: The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically. allOf: - $ref: '#/components/schemas/GoogleCloudRegion' accessKey: type: string description: GCS access key example: GOOGTS7C7FUP3AIRVJTE writeOnly: true secretKey: type: string description: GCS secret key example: bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ writeOnly: true GcsServiceAccountInput: title: GcsServiceAccountInput required: - bucketName - serviceAccountCredentials allOf: - $ref: '#/components/schemas/Input' - properties: serviceAccountCredentials: type: string description: GCS projectId example: "{\n \"type\": \"service_account\",\n \"project_id\": \"bitmovin\"\ ,\n \"private_key_id\": \"dfgsgfdsgsgargdf\",\n \"private_key\": \"\ -----BEGIN PRIVATE KEY-----\\nOwdXyjRT9F4A==\\n-----END PRIVATE KEY-----\\\ n\",\n \"client_email\": \"bitmovin@bitmovin.iam.gserviceaccount.com\"\ ,\n \"client_id\": \"10440564562784234997\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\"\ ,\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\"\ : \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\"\ : \"https://www.googleapis.com/robot/v1/metadata/x509/bitmovin%40bitmovin.iam.gserviceaccount.com\"\ \n}\n" writeOnly: true bucketName: type: string description: Name of the bucket example: video-bucket cloudRegion: description: The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically. allOf: - $ref: '#/components/schemas/GoogleCloudRegion' GenericS3Input: title: GenericS3Input required: - bucketName - host - accessKey - secretKey allOf: - $ref: '#/components/schemas/Input' - properties: bucketName: type: string description: Your generic S3 bucket name example: video-bucket host: type: string description: The generic S3 server hostname (or IP address) example: s3.yourdomain.example port: type: integer description: The port on which the generic S3 server is running on (if not provided 8000 will be used) example: 50123 ssl: type: boolean description: Controls whether SSL is used or not example: false signingRegion: type: string description: The signing region to use example: eu-west-1 signatureVersion: allOf: - $ref: '#/components/schemas/S3SignatureVersion' description: Specifies the method used for authentication example: S3_V4 accessKey: type: string description: Your generic S3 access key example: AKIAIOSFODNN7EXAMPLE writeOnly: true secretKey: type: string description: Your generic S3 secret key example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY writeOnly: true accessStyle: allOf: - $ref: '#/components/schemas/S3AccessStyle' description: Specifies the URL access style to use example: VIRTUAL_HOSTED S3SignatureVersion: title: S3SignatureVersion type: string enum: - S3_V2 - S3_V4 default: S3_V4 S3AccessStyle: title: S3AccessStyle description: Specifies whether to use path or virtual-hosted style access type: string enum: - VIRTUAL_HOSTED - PATH x-enum-elements: - name: VIRTUAL_HOSTED description: 'virtual-hosted style (example: bucket-name.s3.example.com)' - name: PATH description: 'path style (example: s3.example.com/bucket-name)' AdMarkersSource: title: AdMarkersSource type: string enum: - MANIFEST - SEGMENTS HlsInput: title: HlsInput allOf: - $ref: '#/components/schemas/Input' - properties: url: type: string description: URL of HLS input example: https://url.manifest.m3u8 adMarkersSource: description: 'Specifies the source for ad markers messages: - MANIFEST: Ad marker messages are read from tags in the HLS manifest - SEGMENTS: Ad marker messages are read from the content segments from the data stream ' example: MANIFEST allOf: - $ref: '#/components/schemas/AdMarkersSource' HttpInput: title: HttpInput required: - host allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string description: Host Url or IP of the HTTP server example: bitmovin.com username: type: string description: Basic Auth Username, if required example: encodingInputUser writeOnly: true password: type: string description: Basic Auth Password, if required example: 3nc0d3d! writeOnly: true port: type: integer description: Custom Port example: 2222 HttpsInput: title: HttpsInput required: - host allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string description: Host Url or IP of the HTTP server example: bitmovin.com username: type: string description: Basic Auth Username, if required example: encodingInputUser writeOnly: true password: type: string description: Basic Auth Password, if required example: 3nc0d3d! writeOnly: true port: type: integer description: Custom Port example: 2222 S3RoleBasedInput: title: S3RoleBasedInput required: - bucketName - roleArn allOf: - $ref: '#/components/schemas/Input' - properties: bucketName: type: string description: Amazon S3 bucket name example: myS3Bucket roleArn: type: string description: "Amazon ARN of the IAM Role (Identity and Access Management\ \ Role) that will be assumed for S3 access.\n\nThis role has to be created\ \ by the owner of the account with the S3 bucket (i.e., you as a customer).\ \ For Bitmovin to be able to assume this role, the following has to\ \ be added\nto the trust policy of the role:\n\n```\n{\n \"Effect\"\ : \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"\ StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n \ \ }\n }\n}\n```\n\nwhere \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \ is the Bitmovin user used for the access.\nThe `Condition` is optional\ \ but we highly recommend it, see property `externalId` below for more\ \ information.\n\nThis setup allows Bitmovin assume the provided IAM\ \ role and to read data from your S3 bucket. Please note that the IAM\ \ role has to have read access on S3.\n\nFor more information about\ \ role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\n" example: arn:aws:iam::123456789012:role/OurS3AccessRole writeOnly: true externalId: type: string description: "External ID used together with the IAM role identified by\ \ `roleArn` to assume S3 access.\n\nThis ID is provided by the API if\ \ `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it\ \ has to be added to the trust policy of the IAM role `roleArn` configured\ \ above, otherwise the API won't be able to read from the S3 bucket.\ \ An appropriate trust policy would look like this:\n\n```\n{\n \"\ Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"\ StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n \ \ }\n }\n}\n```\n\nwhere \"{{externalId}}\" is the generated ID.\n\ \nThis property is optional but we recommend it as an additional security\ \ feature. We will use both the `roleArn` and the `externalId` to access\ \ your S3 data.\nIf the Amazon IAM role has an external ID configured\ \ but it is not provided in the input configuration Bitmovin won't be\ \ able to read from the S3 bucket. Also if the\nexternal ID does not\ \ match the one configured for the IAM role on AWS side, Bitmovin won't\ \ be able to access the S3 bucket.\n\nIf you need to change the external\ \ ID that is used by your IAM role, you need to create a new input,\ \ and use the external ID provided by the API to update your IAM role.\n\ \nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\n" example: fe8e171b-1953-452c-a3b5-b098c534d71c externalIdMode: allOf: - $ref: '#/components/schemas/ExternalIdMode' cloudRegion: allOf: - $ref: '#/components/schemas/AwsCloudRegion' ExternalIdMode: title: ExternalIdMode type: string enum: - CUSTOM - GLOBAL - GENERATED default: CUSTOM x-enum-elements: - name: CUSTOM description: ExternalId can be provided by using the the `externalId` property. This way is not recommend by AWS (https://aws.amazon.com/blogs/security/how-to-use-external-id-when-granting-access-to-your-aws-resources/). - name: GLOBAL description: The response will include an externalId that's unique and consistent for your organization - name: GENERATED description: The response will include a random externalId. SftpInput: title: SftpInput required: - host allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string description: Host Url or IP of the SFTP server example: bitmovin.com port: type: integer description: 'Port to use, standard for SFTP: 22' example: 22 passive: type: boolean description: Use passive mode. Default is true. example: true username: type: string description: Your SFTP Username example: encodingInputUser writeOnly: true password: type: string description: Your SFTP password example: 3nc0d3d! writeOnly: true SrtInput: title: SrtInput required: - mode - port allOf: - $ref: '#/components/schemas/Input' - properties: mode: allOf: - $ref: '#/components/schemas/SrtMode' description: The SRT mode to use example: LISTENER host: type: string description: The name or IP of the host providing the SRT stream (only used in CALLER mode) example: 104.16.9.58 port: type: integer description: The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode. example: 2088 path: type: string description: The path parameter of the SRT stream example: path/to/stream latency: type: integer description: The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both) example: 120 passphrase: type: string writeOnly: true description: The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase example: mysecretpassphrase keyLength: type: integer description: The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase. example: 16 backupSrtInputs: $ref: '#/components/schemas/BackupSrtInputs' BackupSrtInputs: title: BackupSrtInputs required: - srtInputs properties: delayThreshold: type: integer description: When there is no input signal present for this number of seconds, the encoder will switch to the next input default: 30 example: 10 srtInputs: type: array items: $ref: '#/components/schemas/SrtInput' SrtMode: title: SrtMode type: string enum: - LISTENER - CALLER ZixiInput: title: ZixiInput allOf: - $ref: '#/components/schemas/Input' - properties: host: type: string port: type: integer stream: type: string password: type: string latency: type: integer minBitrate: type: integer decryptionType: type: string decryptionKey: type: string AkamaiNetStorageOutput: title: AkamaiNetStorageOutput required: - host - username - password allOf: - $ref: '#/components/schemas/Output' - properties: host: type: string description: Host to use for Akamai NetStorage transfers example: youraccount.akamaihd.net username: type: string description: Your Akamai NetStorage Username example: encodingInputUser writeOnly: true password: type: string description: Your Akamai NetStorage password example: myUncrackablePassword writeOnly: true Output: title: Output allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: acl: deprecated: true description: 'Deprecation notice: This property does not have any effect and will not be returned by GET endpoints' type: array items: $ref: '#/components/schemas/AclEntry' AzureOutput: title: AzureOutput required: - container - accountName oneOf: - title: Authenticate with Entra ID Service Principal required: - servicePrincipal - title: Authenticate with Account Key required: - accountKey allOf: - $ref: '#/components/schemas/Output' - properties: accountName: type: string description: Azure Account Name example: devstoreaccount1 writeOnly: true accountKey: type: string description: Azure Account Key example: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw== writeOnly: true deprecated: true servicePrincipal: allOf: - $ref: '#/components/schemas/AzureServicePrincipal' container: type: string description: Name of the bucket example: video-container FtpOutput: title: FtpOutput required: - host allOf: - $ref: '#/components/schemas/Output' - properties: host: type: string description: Host URL or IP of the FTP server example: bitmovin.com port: type: integer description: 'Port to use, standard for FTP: 21' example: 21 passive: type: boolean description: Use passive mode. Default is true. example: true username: type: string description: Your FTP Username example: encodingInputUser writeOnly: true password: type: string description: Your FTP password example: 3nc0d3d! writeOnly: true transferVersion: description: Controls which transfer version should be used allOf: - $ref: '#/components/schemas/TransferVersion' maxConcurrentConnections: type: integer description: Restrict maximum concurrent connections. Requires at least version 1.1.0. example: 20 TransferVersion: title: TransferVersion type: string enum: - DEFAULT - POOL GcsOutput: title: GcsOutput required: - bucketName - accessKey - secretKey allOf: - $ref: '#/components/schemas/Output' - properties: accessKey: type: string description: GCS access key example: GOOGTS7C7FUP3AIRVJTE writeOnly: true secretKey: type: string description: GCS secret key example: bGoa+V7g/yqDXvKRqq+JTFn4uQZbPiQJo4pf9RzJ writeOnly: true bucketName: type: string description: Name of the bucket example: video-bucket cloudRegion: description: The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically. allOf: - $ref: '#/components/schemas/GoogleCloudRegion' GcsServiceAccountOutput: title: GcsServiceAccountOutput required: - bucketName - serviceAccountCredentials allOf: - $ref: '#/components/schemas/Output' - properties: serviceAccountCredentials: type: string description: GCS projectId example: "{\n \"type\": \"service_account\",\n \"project_id\": \"bitmovin\"\ ,\n \"private_key_id\": \"dfgsgfdsgsgargdf\",\n \"private_key\": \"\ -----BEGIN PRIVATE KEY-----\\nOwdXyjRT9F4A==\\n-----END PRIVATE KEY-----\\\ n\",\n \"client_email\": \"bitmovin@bitmovin.iam.gserviceaccount.com\"\ ,\n \"client_id\": \"10440564562784234997\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\"\ ,\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\"\ : \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\"\ : \"https://www.googleapis.com/robot/v1/metadata/x509/bitmovin%40bitmovin.iam.gserviceaccount.com\"\ \n}\n" writeOnly: true bucketName: type: string description: Name of the bucket example: video-bucket cloudRegion: description: The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically. allOf: - $ref: '#/components/schemas/GoogleCloudRegion' GenericS3Output: title: GenericS3Output required: - accessKey - secretKey - bucketName - host allOf: - $ref: '#/components/schemas/Output' - properties: accessKey: type: string description: Your generic S3 access key example: AKIAIOSFODNN7EXAMPLE writeOnly: true secretKey: type: string description: Your generic S3 secret key example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY writeOnly: true bucketName: type: string description: Name of the bucket example: video-bucket host: type: string description: The Generic S3 server hostname (or IP address) example: s3.yourdomain.example port: type: integer description: The port on which the Generic S3 server is running on (if not provided 8000 will be used) example: 50123 ssl: type: boolean description: Controls whether SSL is used or not example: false signingRegion: type: string description: The signing region to use example: eu-west-1 signatureVersion: allOf: - $ref: '#/components/schemas/S3SignatureVersion' description: Specifies the method used for authentication example: S3_V4 accessStyle: allOf: - $ref: '#/components/schemas/S3AccessStyle' description: Specifies the URL access style to use example: VIRTUAL_HOSTED DnsMappingRequest: title: DnsMappingRequest type: object required: - subdomain properties: subdomain: type: string description: Subdomain used for the DNS mapping. It can only contain lowercase letters, numbers and dashes (-). It can be at most 63 characters long example: my-event-1 name: type: string description: Optional name for the DNS mapping example: Foo bar name description: type: string description: Optional description for the DNS mapping example: Foo bar description DnsMappingResponse: title: DnsMappingResponse allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: subdomain: type: string description: Subdomain used for the DNS mapping example: my-event-1 hostname: type: string readOnly: true description: Resolved hostname for the DNS mapping example: my-event-1.live-input-li.bitcod.in encodingId: type: string readOnly: true description: ID of the encoding this DNS mapping belongs to example: be274f1d-c988-4583-8f82-f725de74f002 ip: type: string readOnly: true description: IP address that the hostname resolves to example: 192.0.2.1 LiveStandbyPoolRequest: title: LiveStandbyPoolRequest required: - targetPoolSize - encodingTemplate allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: targetPoolSize: type: integer description: Number of instances to keep ready for streaming while the pool is running minimum: 0 example: '10' encodingTemplate: type: string description: Base64 encoded template used to start the encodings in the pool example: bWV0YWRhdGE6DQogIHR5cGU6IExJVkUNCiAgbmFtZ... LiveStandbyPoolResponse: title: LiveStandbyPoolResponse required: - targetPoolSize allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: targetPoolSize: type: integer description: Number of instances to keep ready for streaming while the pool is running minimum: 0 example: '10' readOnly: true readyEncodings: type: integer description: Number of instances currently in ready state in the pool minimum: 0 example: '10' readOnly: true preparingEncodings: type: integer description: Number of instances currently being prepared in the pool minimum: 0 example: '10' readOnly: true errorEncodings: type: integer description: Number of instances currently in error state in the pool minimum: 0 example: '10' readOnly: true encodingTemplateName: type: string description: The name of the encoding template used with this Standby Pool example: Live Template 1080p poolStatus: allOf: - $ref: '#/components/schemas/LiveStandbyPoolStatus' LiveStandbyPoolDetails: title: LiveStandbyPoolDetails allOf: - $ref: '#/components/schemas/LiveStandbyPoolResponse' - properties: encodingTemplate: readOnly: true type: string description: Base64 encoded template used to start the encodings in the pool example: bWV0YWRhdGE6DQogIHR5cGU6IExJVkUNCiAgbmFtZ... LiveStandbyPoolStatus: title: LiveStandbyPoolStatus description: Status of the live standby pool type: string enum: - HEALTHY - ERROR example: HEALTHY x-enum-elements: - name: HEALTHY description: 'The standby pool is in healthy state ' - name: ERROR description: 'The standby pool is in error state ' LiveStandbyPoolEncoding: title: LiveStandbyPoolEncoding allOf: - properties: id: type: string readOnly: true createdAt: type: string readOnly: true modifiedAt: type: string readOnly: true encodingId: type: string readOnly: true description: ID of the encoding that ready for ingest in the standby pool manifests: type: array items: $ref: '#/components/schemas/LiveStandbyPoolEncodingManifest' ingestPoints: type: array readOnly: true items: $ref: '#/components/schemas/LiveStandbyPoolEncodingIngestPoint' status: allOf: - $ref: '#/components/schemas/LiveStandbyPoolEncodingStatus' LiveStandbyPoolEncodingManifest: title: LiveStandbyPoolEncodingManifest allOf: - properties: url: type: string readOnly: true description: URL to the manifest manifestId: type: string readOnly: true description: ID of the manifest that was created for the encoding type: type: string readOnly: true allOf: - $ref: '#/components/schemas/LiveStandbyPoolEncodingManifestType' LiveStandbyPoolEncodingManifestType: title: LiveStandbyPoolEncodingManifestType description: Type of the manifest type: string enum: - DASH - HLS example: DASH x-enum-elements: - name: DASH description: 'The manifest is a DASH manifest ' - name: HLS description: 'The manifest is a HLS manifest ' LiveStandbyPoolEncodingStatus: title: LiveStandbyPoolEncodingStatus description: Status of the standby pool encoding type: string enum: - TO_BE_CREATED - CREATING - PREPARING - READY - TO_BE_DELETED - DELETING - ACQUIRED - ERROR example: READY x-enum-elements: - name: TO_BE_CREATED description: 'The encoding is about to be created ' - name: CREATING description: 'The encoding is being created ' - name: PREPARING description: 'The encoding is starting and configured and not ready for streaming yet ' - name: READY description: 'The encoding is ready to be acquired from the pool ' - name: TO_BE_DELETED description: 'The encoding is about to be deleted ' - name: DELETING description: 'The encoding is being deleted ' - name: ACQUIRED description: 'The encoding of the pool is acquired and removed from the pool ' - name: ERROR description: 'The encoding of the pool is in error state ' LiveStandbyPoolEncodingIngestPoint: title: LiveStandbyPoolEncodingIngestPoint allOf: - properties: streamBaseUrl: type: string example: rtmps://company-streamer123.live-input-li.bitcod.in/live description: URL to the RTMP/RTMPS endpoint for this live encoding streamKey: type: string example: 5ef5862b-1fdf-4972-8c23-900f47b68953 description: Stream key value of this live encoding LiveStandbyPoolAcquireEncoding: title: LiveStandbyPoolAcquireEncoding properties: ingestPoints: type: array description: 'Note: This is not implemented yet and will be ignored if provided. List of ingest points to be used for the acquired encoding. The DNS hostname and RTMPs application name and streamKey will be assigned to the encoding. ' items: $ref: '#/components/schemas/LiveStandbyPoolEncodingIngestPoint' StreamKey: title: StreamKey allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: value: type: string description: 'Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings. If this value is not provided, a unique random stream key will be generated. **Important:** This value has to be globally unique. If it is set manually, be sure to use a secure value. If the stream key value is guessed by others your live encoding can be compromised. ' example: 9m4e2mr0ui3e8a215n4g status: allOf: - $ref: '#/components/schemas/StreamKeyStatus' type: string readOnly: true description: Status of the stream key default: UNASSIGNED example: UNASSIGNED type: allOf: - $ref: '#/components/schemas/StreamKeyType' type: string readOnly: true description: Type of the stream key default: RESERVED example: RESERVED assignedEncodingId: type: string readOnly: true description: ID of the encoding that is assigned to this stream key. Not set if status is UNASSIGNED assignedIngestPointId: type: string readOnly: true description: ID of the ingest point that is assigned to this stream key. Not set if status is UNASSIGNED StreamKeyStatus: title: StreamKeyStatus description: Status of the stream key type: string enum: - ASSIGNED - UNASSIGNED example: UNASSIGNED x-enum-elements: - name: ASSIGNED description: "Stream key is assigned to a live encoding. \nThis means, it\ \ **can not be assigned** to a RedundantRtmpInput at the moment.\nIt will\ \ be set to UNASSIGNED if the live encoding is finished or in error state\n" - name: UNASSIGNED description: "Stream key is not assigned to a live encoding. \nThis means,\ \ that it **is available** to be used with a RedundantRtmpInput\n" StreamKeyType: title: StreamKeyType description: Type of the stream key type: string enum: - RESERVED - TEMPORARY example: RESERVED x-enum-elements: - name: RESERVED description: Stream key is persistent and can be reused. It can be assigned to a live encoding when it is currently not in use - name: TEMPORARY description: Stream key is automatically generated for a live encoding. They can not be reused. After the encoding is finished, the stream key will be gone also StreamKeysUnassignAction: title: StreamKeysUnassignAction properties: encodingId: type: string example: 2a35060e-87c6-4b9a-abf7-8ca3f7a094c4 description: Encoding ID for which stream keys should be unassigned DashISO8601TimestampFormat: title: DashISO8601TimestampFormat type: string enum: - LONG - SHORT example: LONG default: LONG x-enum-elements: - name: LONG description: Format for generating timestamps in PXXYXXMXXDTXXHXXMX.XXXS - name: SHORT description: Format for generating timestamps in PTXXHXXMX.XXXS DashManifest: title: DashManifest allOf: - $ref: '#/components/schemas/Manifest' - properties: profile: description: Determines if segmented or progressive representations can appear in the manifest allOf: - $ref: '#/components/schemas/DashProfile' manifestName: type: string description: The filename of your manifest example: stream.mpd namespaces: type: array description: List of additional XML namespaces to add to the DASH Manifest items: $ref: '#/components/schemas/XmlNamespace' utcTimings: type: array description: List of UTC Timings to use for live streaming items: $ref: '#/components/schemas/UtcTiming' dashEditionCompatibility: description: The manifest compatibility with the standard DASH Edition. allOf: - $ref: '#/components/schemas/DashEditionCompatibility' iso8601TimestampFormat: description: Determines how timestamps should appear in the manifest allOf: - $ref: '#/components/schemas/DashISO8601TimestampFormat' minBufferTime: type: number format: double description: 'The minimum buffer time in seconds that the client should maintain to ensure uninterrupted playback. Default is 2 seconds. Note: For VOD ON_DEMAND dash manifests, the default value may differ from 2.0 seconds if not explicitly set. ' default: 2 example: 2 DashProfile: title: DashProfile type: string enum: - LIVE - ON_DEMAND example: ON_DEMAND default: LIVE x-enum-elements: - name: LIVE description: Profile that supports segmented representations/muxings (FMP4, CMAF, WEBM, CHUNKED_TEXT) - name: ON_DEMAND description: Profile that supports progressive representations/muxings (MP4, PROGRESSIVE_WEBM) DashEditionCompatibility: title: DashEditionCompatibility type: string enum: - V4 example: V4 x-enum-elements: - name: V4 description: States the compatibility of the DASH manifest with the standard DASH Edition. When set to V4, the endNumber attribute will be automatically added to the last Media Segment in the Representation of the Period, in order to improve playback compatibility. If the property is not set the endNumber attribute tag will not be added. 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 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. UtcTiming: title: UtcTiming required: - value - schemeIdUri properties: value: type: string description: The server to get the time from example: https://time.server.com/ schemeIdUri: type: string description: The scheme id to use. Please refer to the DASH standard. example: urn:mpeg:dash:utc:http-iso:2014 XmlNamespace: title: XmlNamespace required: - prefix - uri properties: prefix: type: string description: Name of the XML Namespace reference example: mynamespace uri: type: string description: Source of the XML Namespace reference example: 'urn:mycompany:mynamespace:2018:xml+bin ' DefaultDashManifestPeriod: title: DefaultDashManifestPeriod allOf: - properties: encodingIds: type: array description: List the encoding ids for which the conditions should apply items: type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 adaptationSets: type: array description: Adds an adaption set for every item to the period items: $ref: '#/components/schemas/DefaultManifestCondition' DefaultManifestCondition: title: DefaultManifestCondition DashManifestDefault: title: DashManifestDefault allOf: - $ref: '#/components/schemas/DashManifest' - properties: encodingId: description: The id of the encoding to create a default manifest for. Either "encodingId" or "periods" is required. type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 version: description: Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the "manifestGenerator" version of the "Start" request. allOf: - $ref: '#/components/schemas/DashManifestDefaultVersion' periods: description: Adds a period for every item. Can only be used when setting "version" to "V2". Either "periods" or "encodingId" is required. type: array items: $ref: '#/components/schemas/DefaultDashManifestPeriod' DashManifestDefaultVersion: title: DashManifestDefaultVersion type: string default: V1 enum: - V1 - V2 Accessibility: title: Accessibility required: - value - schemeIdUri properties: value: type: string description: Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology) example: CC1=eng schemeIdUri: type: string description: The scheme id to use. Please refer to the DASH standard. example: urn:scte:dash:cc:cea-608:2015 AdaptationSet: title: AdaptationSet allOf: - $ref: '#/components/schemas/BitmovinResponse' - properties: customAttributes: type: array items: $ref: '#/components/schemas/CustomAttribute' description: Custom adaptation set attributes roles: type: array items: $ref: '#/components/schemas/AdaptationSetRole' description: Roles of the adaptation set accessibilities: type: array items: $ref: '#/components/schemas/Accessibility' description: Provide signaling of CEA 607 and CEA 708 labels: type: array items: $ref: '#/components/schemas/Label' description: List of labels AdaptationSetRole: title: AdaptationSetRole type: string enum: - ALTERNATE - CAPTION - COMMENTARY - DUB - MAIN - SUBTITLE - SUPPLEMENTARY example: MAIN x-enum-elements: - name: ALTERNATE description: Media content component that is an alternative to a main media content component of the same media component type - name: CAPTION description: Caption - name: COMMENTARY description: Media content component with commentary (typically audio, e.g. director's commentary) - name: DUB description: Media content component which is presented in a different language from the original (e.g. dubbed audio, translated captions) - name: MAIN description: Main media component which is intended for presentation if no other information is provided - name: SUBTITLE description: Subtitle - name: SUPPLEMENTARY description: Media content component that is supplementary to a media content component of a different media component type AudioAdaptationSet: title: AudioAdaptationSet required: - lang allOf: - $ref: '#/components/schemas/AdaptationSet' - properties: lang: type: string description: ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set example: en CustomAttribute: title: CustomAttribute required: - key properties: key: type: string description: unique string identifier for the custom attribute example: key name value: type: string description: value of the custom attribute example: value Label: title: Label required: - value properties: id: type: integer format: int64 minimum: 0 description: Identifier of the label. lang: type: string description: Specifies the language of the label. value: type: string description: Content of the label. ContentProtection: title: ContentProtection required: - drmId allOf: - $ref: '#/components/schemas/DashMuxingRepresentation' - properties: drmId: type: string description: DRM Id example: 826949d5-0877-46cc-9daf-d75903682f27 DashMuxingRepresentation: title: DashMuxingRepresentation required: - encodingId - muxingId allOf: - $ref: '#/components/schemas/DashRepresentation' - properties: encodingId: type: string description: UUID of an encoding example: 5002a2a2-9dd4-4ddf-904a-46f6eec23217 muxingId: type: string description: UUID of a muxing example: 55354be6-0237-42bb-ae85-a2d4ef1ed19e dependencyId: type: string description: Used to signal a dependency with another representation. The representation may belong to a different adaptation set example: 64f873aa-9cbe-4816-a0dc-c853e5c04e05 DashRepresentation: title: DashRepresentation allOf: - $ref: '#/components/schemas/BitmovinResponse' ImageAdaptationSet: title: ImageAdaptationSet allOf: - $ref: '#/components/schemas/AdaptationSet' DashChunkedTextRepresentation: title: DashChunkedTextRepresentation allOf: - $ref: '#/components/schemas/DashSegmentedRepresentation' DashRepresentationType: title: DashRepresentationType type: string enum: - TEMPLATE - LIST - TIMELINE example: TEMPLATE x-enum-elements: - name: TEMPLATE description: Generates a SegmentTemplate which will be positioned under the representation - name: LIST description: Generates a SegmentList based representation - name: TIMELINE description: Generates a SegmentTimeline based representation DashRepresentationTypeMode: title: DashRepresentationTypeMode type: string enum: - TEMPLATE_REPRESENTATION - TEMPLATE_ADAPTATION_SET example: TEMPLATE_REPRESENTATION default: TEMPLATE_REPRESENTATION x-enum-elements: - name: TEMPLATE_REPRESENTATION description: Generates representations containing segment templates. - name: TEMPLATE_ADAPTATION_SET description: Generates segment templates in the adaption sets. The representations will not contain any segment templates anymore. DashSegmentedRepresentation: title: DashSegmentedRepresentation required: - type - segmentPath allOf: - $ref: '#/components/schemas/DashMuxingRepresentation' - properties: type: description: '' allOf: - $ref: '#/components/schemas/DashRepresentationType' mode: description: '' allOf: - $ref: '#/components/schemas/DashRepresentationTypeMode' segmentPath: type: string description: Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET example: path/to/segments startSegmentNumber: type: integer format: int64 description: Number of the first segment example: 0 endSegmentNumber: type: integer format: int64 description: Number of the last segment. Default is the last one that was encoded example: 1701 startKeyframeId: type: string description: Id of the keyframe to start with. It takes precedence over startSegmentNumber example: ea49cfbe-777e-4a4c-a485-a1578154ff49 endKeyframeId: type: string description: Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation. example: 2a49cfbe-777e-4a4c-a485-a1578154ff42 DashCmafRepresentation: title: DashCmafRepresentation allOf: - $ref: '#/components/schemas/DashSegmentedRepresentation' DashFmp4Representation: title: DashFmp4Representation allOf: - $ref: '#/components/schemas/DashSegmentedRepresentation' DashFmp4DrmRepresentation: title: DashFmp4DrmRepresentation required: - drmId allOf: - $ref: '#/components/schemas/DashFmp4Representation' - properties: drmId: type: string description: DRM Id example: 826949d5-0877-46cc-9daf-d75903682f27 DashImscRepresentation: title: DashImscRepresentation required: - imscUrl allOf: - $ref: '#/components/schemas/DashRepresentation' - properties: imscUrl: type: string description: URL of the referenced IMSC file example: https://yourhost.com/path/mysubtitles.xml DashMp4Representation: title: DashMp4Representation required: - filePath allOf: - $ref: '#/components/schemas/DashMuxingRepresentation' - properties: filePath: type: string description: Path to the MP4 file example: path/to/mp4 type: type: string description: The type of the dash representation allOf: - $ref: '#/components/schemas/DashOnDemandRepresentationType' default: SEGMENT_BASE DashOnDemandRepresentationType: title: DashOnDemandRepresentationType type: string enum: - SEGMENT_BASE - SEGMENT_LIST example: SEGMENT_BASE x-enum-elements: - name: SEGMENT_BASE description: Generates a SegmentBase representation - name: SEGMENT_LIST description: Generates a SegmentList representation DashMp4DrmRepresentation: title: DashMp4DrmRepresentation required: - drmId allOf: - $ref: '#/components/schemas/DashMp4Representation' - properties: drmId: type: string description: DRM Id example: 826949d5-0877-46cc-9daf-d75903682f27 DashProgressiveWebmRepresentation: title: DashProgressiveWebmRepresentation required: - filePath allOf: - $ref: '#/components/schemas/DashMuxingRepresentation' - properties: filePath: type: string description: Path to the Progressive WebM file example: path/to/progressive-webm SpriteRepresentation: title: SpriteRepresentation required: - encodingId - streamId - spriteId - segmentPath allOf: - $ref: '#/components/schemas/DashRepresentation' - properties: encodingId: type: string description: UUID of an encoding example: 5002a2a2-9dd4-4ddf-904a-46f6eec23217 streamId: type: string description: UUID of a stream example: 5002a2a2-9dd4-4ddf-904a-46f6eec23217 spriteId: type: string description: UUID of a Sprite example: 55354be6-0237-42bb-ae85-a2d4ef1ed19e segmentPath: type: string description: Path to sprite segments. Will be used as the representation id in the manifest. example: path/to/segments DashVttRepresentation: title: DashVttRepresentation required: - vttUrl allOf: - $ref: '#/components/schemas/DashRepresentation' - properties: vttUrl: type: string description: URL of the referenced VTT file example: https://yourhost.com/path/mysubtitles.vtt DashWebmRepresentation: title: DashWebmRepresentation allOf: - $ref: '#/components/schemas/DashSegmentedRepresentation' SubtitleAdaptationSet: title: SubtitleAdaptationSet required: - lang allOf: - $ref: '#/components/schemas/AdaptationSet' - properties: lang: type: string description: ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set example: en VideoAdaptationSet: title: VideoAdaptationSet allOf: - $ref: '#/components/schemas/AdaptationSet' Period: title: Period allOf: - $ref: '#/components/schemas/BitmovinResponse' - properties: start: type: number format: double description: Starting time in seconds example: 266.5 duration: type: number format: double description: 'Duration in seconds.
Please note that the duration of a Period is usually determined by the media contained therein.
Setting the `duration` property to a specific value will override this default behaviour.
Warning: Use at your own risk!' example: 10.25 CustomXmlElement: title: CustomXmlElement required: - data allOf: - $ref: '#/components/schemas/BitmovinResponse' - properties: data: type: string description: String representation of the XML element example: 'some_text ' ManifestGenerator: title: ManifestGenerator type: string default: LEGACY enum: - LEGACY - V2 x-enum-elements: - name: LEGACY description: Legacy manifest generator. - name: V2 description: Improved manifest generator which covers all manifest features available in our API. StartManifestRequest: title: StartManifestRequest properties: manifestGenerator: description: 'Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation. ' allOf: - $ref: '#/components/schemas/ManifestGenerator' ChannelsAttributeForAudio: title: ChannelsAttributeForAudio type: string default: LEGACY enum: - ALWAYS - STANDARD_CONFORM - LEGACY example: LEGACY x-enum-elements: - name: ALWAYS description: Always add CHANNELS attribute - name: STANDARD_CONFORM description: Add CHANNELS attribute according to the HLS specifications - name: LEGACY description: Legacy setting for the CHANNELS attribute HlsManifest: title: HlsManifest allOf: - $ref: '#/components/schemas/Manifest' - properties: manifestName: type: string description: The filename of your manifest. If this is not set, the `name` is used as output file name. Either one of `name` or `manifestName` is required. Be aware that spaces will be replaced with underlines (`_`) on the output. example: stream.m3u8 hlsMediaPlaylistVersion: description: If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version allOf: - $ref: '#/components/schemas/HlsVersion' hlsMasterPlaylistVersion: description: If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version allOf: - $ref: '#/components/schemas/HlsVersion' channelsAttributeForAudio: description: Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag allOf: - $ref: '#/components/schemas/ChannelsAttributeForAudio' targetDurationRoundingMode: description: 'The rounding applied to target duration. Two possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer, or UPWARDS_ROUNDING, when the target duration is rounded to the highest integer. ' allOf: - $ref: '#/components/schemas/HlsTargetDurationRoundingMode' HlsVersion: title: HlsVersion type: string enum: - 3 - 4 - 5 - 6 - 7 - 8 example: 7 x-enum-elements: - name: HLS_V3 description: HLS version 3 - name: HLS_V4 description: HLS version 4 - name: HLS_V5 description: HLS version 5 - name: HLS_V6 description: HLS version 6 - name: HLS_V7 description: HLS version 7 - name: HLS_V8 description: HLS version 8 HlsTargetDurationRoundingMode: title: HlsTargetDurationRoundingMode type: string default: NORMAL_ROUNDING enum: - UPWARD_ROUNDING - NORMAL_ROUNDING x-enum-elements: - name: UPWARD_ROUNDING description: 'The target duration will be always rounded upwards. For example: if the target duration is 4.2 this will be rounded to 5. ' - name: NORMAL_ROUNDING description: "The target duration will be normally rounded.\n\n For example:\ \ if the target duration is 4.2 this will be rounded to 4.\n" HlsManifestDefault: title: HlsManifestDefault required: - encodingId allOf: - $ref: '#/components/schemas/HlsManifest' - properties: encodingId: description: The id of the encoding to create a default manifest for type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 version: description: Currently not in use allOf: - $ref: '#/components/schemas/HlsManifestDefaultVersion' HlsManifestDefaultVersion: title: HlsManifestDefaultVersion type: string default: V1 enum: - V1 AudioMediaInfo: title: AudioMediaInfo allOf: - $ref: '#/components/schemas/StandardMediaInfo' - properties: forced: type: boolean description: A value of true indicates that the Rendition contains content which is considered essential to play. example: false BasicMediaInfo: title: BasicMediaInfo required: - groupId - name allOf: - $ref: '#/components/schemas/BitmovinResponse' - properties: groupId: type: string description: The value is a quoted-string which specifies the group to which the Rendition belongs. example: audio_group language: type: string description: Primary language in the rendition. example: en assocLanguage: type: string description: Identifies a language that is associated with the Rendition. example: de name: type: string description: Human readable description of the rendition. example: Rendition description isDefault: type: boolean description: If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user. example: false autoselect: type: boolean description: If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference. example: false characteristics: type: array items: type: string description: Contains Uniform Type Identifiers example: - public.accessibility.describes-video SegmentsMediaInfo: title: SegmentsMediaInfo required: - segmentPath - encodingId - streamId - muxingId allOf: - $ref: '#/components/schemas/BasicMediaInfo' - properties: segmentPath: type: string description: Path to segments. example: path/to/segments encodingId: type: string description: Id of the encoding. example: 4f4fd5df-4bbd-4e84-8065-194a1b408c3b streamId: type: string description: Id of the stream. example: 40139937-1cf5-4c3f-ace3-467fd2fd74ce muxingId: type: string description: Id of the muxing. example: 380cc8da-c315-4d08-b1d9-9a6830a55f62 drmId: type: string description: Id of the DRM. example: 14225e77-0258-4eb6-af40-37488198c1ab startSegmentNumber: type: integer format: int64 description: Number of the first segment. Default is 0. example: 0 endSegmentNumber: type: integer format: int64 description: Number of the last segment. Default is the last one that was encoded. example: 4603 StandardMediaInfo: title: StandardMediaInfo required: - uri allOf: - $ref: '#/components/schemas/SegmentsMediaInfo' - properties: uri: type: string description: The URI of the Rendition example: myrendition.m3u8 ClosedCaptionsMediaInfo: title: ClosedCaptionsMediaInfo required: - instreamId allOf: - $ref: '#/components/schemas/SegmentsMediaInfo' - properties: instreamId: type: string description: Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID) example: CC1 forced: type: boolean description: A value of true indicates that the Rendition contains content which is considered essential to play. example: false CustomTag: title: CustomTag required: - positionMode - data allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: positionMode: description: The positioning mode that should be used when inserting the placement opportunity allOf: - $ref: '#/components/schemas/PositionMode' keyframeId: type: string description: Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode. example: 60be9634-1c91-4aa3-a697-9a76d0b6c1fb time: type: number format: double description: Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode. example: 5.5 segment: type: integer format: int64 description: The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode. example: 74656 data: type: string description: The data to be contained in the custom tag. example: '#AD-PLACEMENT-OPPORTUNITY' PositionMode: title: PositionMode type: string enum: - KEYFRAME - TIME - SEGMENT x-enum-elements: - name: KEYFRAME description: The custom tag will be inserted in the manifest at a certain keyframe id and segment cut. (https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/encodings/create-keyframes) - name: TIME description: The custom tag will be inserted before the segment that is closest to that time (in seconds). - name: SEGMENT description: The custom tag will be inserted before the specified segment number. SubtitlesMediaInfo: title: SubtitlesMediaInfo allOf: - $ref: '#/components/schemas/StandardMediaInfo' - properties: forced: type: boolean description: A value of true indicates that the Rendition contains content which is considered essential to play. example: false VideoMediaInfo: title: VideoMediaInfo allOf: - $ref: '#/components/schemas/StandardMediaInfo' VttMediaInfo: title: VttMediaInfo required: - vttUrl - uri allOf: - $ref: '#/components/schemas/BasicMediaInfo' - properties: vttUrl: type: string description: The URL of the referenced VTT file example: https://yourhost.com/path/mysubtitles.vtt uri: type: string description: The URI of the Rendition example: mysubtitles.m3u8 forced: type: boolean description: A value of true indicates that the Rendition contains content which is considered essential to play. example: false AudioGroup: title: AudioGroup required: - name - priority properties: name: type: string description: Name of the audio group example: audio1 priority: type: integer minimum: 0 maximum: 100 description: Priority of the audio group example: 50 AudioGroupConfiguration: title: AudioGroupConfiguration required: - droppingMode - groups properties: droppingMode: allOf: - $ref: '#/components/schemas/VariantStreamDroppingMode' description: Dropping mode example: STREAM groups: type: array items: $ref: '#/components/schemas/AudioGroup' description: Audio groups example: - name: audio1 priority: 50 StreamInfo: title: StreamInfo required: - closedCaptions - segmentPath - uri - encodingId - streamId - muxingId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: audio: type: string description: It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or `audioGroups` must be set. example: audio_group audioGroups: description: HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or `audio` must be set. allOf: - $ref: '#/components/schemas/AudioGroupConfiguration' video: type: string description: It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist example: video_group subtitles: type: string description: It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist example: subtitles_group closedCaptions: type: string description: If the value is not 'NONE', it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist example: NONE encodingId: type: string description: Id of the encoding. example: 041e18ee-245a-41cb-956d-de2285586b7b streamId: type: string description: Id of the stream. example: 034433c8-898f-4d4b-b792-76103e90ffa6 muxingId: type: string description: Id of the muxing. example: b824ea90-d8e7-472f-b9f7-afa888bc7116 drmId: type: string description: Id of the DRM. example: c65627cc-c920-4ccd-a414-46d31d48377e segmentPath: type: string description: Path to segments. example: path/to/segments uri: type: string description: The URI of the playlist file. example: playlist.m3u8 startSegmentNumber: type: integer format: int64 description: Number of the first segment. Default is 0. example: 0 endSegmentNumber: type: integer format: int64 description: Number of the last segment. Default is the last one that was encoded. example: 4603 forceFrameRateAttribute: type: boolean description: Force the addition of the frame rate attribute to all stream infos. default: true forceVideoRangeAttribute: type: boolean description: Force the addition of the video-range attribute to all stream infos. default: false VariantStreamDroppingMode: title: VariantStreamDroppingMode type: string description: Variant stream dropping mode. enum: - STREAM - AUDIO IFramePlaylist: title: IFramePlaylist required: - filename allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: filename: type: string description: The filename of your I-frame playlist example: iframes.m3u8 SmoothStreamingManifest: title: SmoothStreamingManifest allOf: - $ref: '#/components/schemas/Manifest' - properties: serverManifestName: type: string description: Filename of the server manifest example: stream.ism clientManifestName: type: string description: Filename of the client manifest example: stream.ismc createdAt: type: string format: date-time description: 'Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ' example: '2016-06-25T20:09:23.69Z' readOnly: true modifiedAt: type: string format: date-time description: 'Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ' example: '2016-06-25T20:09:23.69Z' readOnly: true SmoothManifestContentProtection: title: SmoothManifestContentProtection required: - encodingId - muxingId - drmId allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: encodingId: type: string description: Id of the encoding. example: cb90b80c-8867-4e3b-8479-174aa2843f62 muxingId: type: string description: Id of the muxing. example: eabce724-ff1c-41c7-b6e0-34b32e2e37b6 drmId: type: string description: Id of the drm. example: c8f7aeb8-35f6-49d7-afb9-4820d6f910f1 SmoothManifestDefault: title: SmoothManifestDefault required: - encodingId allOf: - $ref: '#/components/schemas/SmoothStreamingManifest' - properties: encodingId: description: The id of the encoding to create a default manifest for type: string example: 45ef21d2-1f62-4004-9166-6d5e248270f6 version: description: Currently not in use allOf: - $ref: '#/components/schemas/SmoothManifestDefaultVersion' SmoothManifestDefaultVersion: title: SmoothManifestDefaultVersion type: string default: V1 enum: - V1 SmoothStreamingRepresentation: title: SmoothStreamingRepresentation required: - encodingId - muxingId - mediaFile allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: encodingId: type: string description: Id of the encoding example: cb90b80c-8867-4e3b-8479-174aa2843f62 muxingId: type: string description: Id of the muxing. example: eabce724-ff1c-41c7-b6e0-34b32e2e37b6 mediaFile: type: string description: The Smooth Streaming ismv or isma file that will be referenced in the manifest. example: path/to/file.ismv language: type: string description: Language of the MP4 file example: en trackName: type: string description: Track where this MP4 shoudl be added example: track_en priority: type: integer description: Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values. example: 50 AkamaiMslStreamFormat: title: AkamaiMslStreamFormat type: string enum: - DASH - HLS - CMAF default: DASH AkamaiMslVersion: title: AkamaiMslVersion type: string enum: - MSL4 default: MSL4 AkamaiMslOutput: title: AkamaiMslOutput required: - streamId - eventName - streamFormat - mslVersion allOf: - $ref: '#/components/schemas/Output' - properties: streamId: type: integer description: The Akamai stream ID example: 3124 eventName: type: string description: The Akamai event name example: myEvent streamFormat: description: '- DASH: configure the Encoding with fMP4 or CMAF muxings and a DASH manifest. - HLS: configure the Encoding with TS muxings and an HLS manifest. - CMAF: configure the Encoding with fMP4 or CMAF muxings with both DASH and HLS manifests. ' example: DASH allOf: - $ref: '#/components/schemas/AkamaiMslStreamFormat' mslVersion: description: The Akamai MSL Version. Only MSL4 is supported at the moment. example: MSL4 allOf: - $ref: '#/components/schemas/AkamaiMslVersion' CheckOutputPermissionsRequest: title: CheckOutputPermissionsRequest allOf: - properties: path: type: string description: The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a "prefix". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory. default: '' example: videos/ CheckOutputPermissionsResponse: title: CheckOutputPermissionsResponse allOf: - properties: outputId: type: string readOnly: true description: Id of the output for which permissions were checked example: 55354be6-0237-42bb-ae85-a2d4ef1ed19e outputType: description: The type of the output for which permissions were checked readOnly: true allOf: - $ref: '#/components/schemas/OutputType' path: type: string readOnly: true description: The path on the storage for which permissions were checked. In AWS S3 terminology, this corresponds to a "prefix". An empty string corresponds to the root directory. example: videos/ passed: type: boolean readOnly: true description: Indicates if permissions on the storage are configured correctly to be used as output target by the Bitmovin encoder. If "false", *failureReason* will provide additional information. example: 'false' failureReason: type: string readOnly: true description: Contains nothing if the check succeeded. Otherwise, contains a message explaining why it failed. example: 'The following required permissions are not set: PutObject' OutputType: title: OutputType type: string enum: - AKAMAI_NETSTORAGE - AZURE - GENERIC_S3 - GCS - FTP - LOCAL - S3 - S3_ROLE_BASED - SFTP - AKAMAI_MSL - LIVE_MEDIA_INGEST - GCS_SERVICE_ACCOUNT - CDN x-enum-elements: - name: AKAMAI_NETSTORAGE - name: AZURE - name: GENERIC_S3 - name: GCS - name: FTP - name: LOCAL - name: S3 - name: S3_ROLE_BASED - name: SFTP - name: AKAMAI_MSL - name: LIVE_MEDIA_INGEST - name: GCS_SERVICE_ACCOUNT - name: CDN LiveMediaIngestOutput: title: LiveMediaIngestOutput description: Live Media and Metadata Ingest Protocol. See https://tools.ietf.org/html/draft-mekuria-mmediaingest-01. required: - publishingPoint allOf: - $ref: '#/components/schemas/Output' - properties: publishingPoint: type: string description: URL specifying the publishing point for the output. Can use either http or https. example: https://live.host.com/some/path/publishingpoint.isml scte35Passthrough: type: boolean description: Enable passthrough of SCTE-35 messages from input to output. Default is false. example: false LocalOutput: title: LocalOutput required: - path allOf: - $ref: '#/components/schemas/Output' - properties: path: type: string description: Path to your local storage example: /mnt/my_local_storage/ S3Output: title: S3Output required: - accessKey - secretKey - bucketName allOf: - $ref: '#/components/schemas/Output' - properties: bucketName: type: string description: Amazon S3 bucket name example: myS3Bucket accessKey: type: string description: Amazon S3 access key example: AKIAIOSFODNN7EXAMPLE writeOnly: true secretKey: type: string description: Amazon S3 secret key example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY writeOnly: true md5MetaTag: type: string description: If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file. example: my-md5-checksum-tag cloudRegion: description: The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically. allOf: - $ref: '#/components/schemas/AwsCloudRegion' signatureVersion: description: Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) allOf: - $ref: '#/components/schemas/S3SignatureVersion' storageClass: description: Specifies the storage class used for the bucket. This depends on the requirements of workloads, like performance, data access, resiliency, and cost. allOf: - $ref: '#/components/schemas/S3StorageClass' S3StorageClass: title: S3StorageClass type: string enum: - GLACIER_IR - INTELLIGENT_TIERING - ONEZONE_IA - REDUCED_REDUNDANCY - STANDARD - STANDARD_IA default: STANDARD S3RoleBasedOutput: title: S3RoleBasedOutput required: - bucketName - roleArn allOf: - $ref: '#/components/schemas/Output' - properties: bucketName: type: string description: Amazon S3 bucket name example: myS3Bucket roleArn: type: string description: "Amazon ARN of the IAM Role (Identity and Access Management\ \ Role) that will be assumed for S3 access.\n\nThis role has to be created\ \ by the owner of the account with the S3 bucket (i.e., you as a customer).\ \ For Bitmovin to be able to assume this role, the following has to\ \ be added\nto the trust policy of the role:\n\n```\n{\n \"Effect\"\ : \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"\ StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n \ \ }\n }\n}\n```\n\nwhere \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \ is the Bitmovin user used for the access.\nThe `Condition` is optional\ \ but we highly recommend it, see property `externalId` below for more\ \ information.\n\nThis setup allows Bitmovin assume the provided IAM\ \ role and to write data to your S3 bucket. Please note that the IAM\ \ role has to have write access to S3.\n\nFor more information about\ \ role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\n" example: arn:aws:iam::123456789012:role/OurS3AccessRole writeOnly: true externalId: type: string description: "External ID used together with the IAM role identified by\ \ `roleArn` to assume S3 access.\n\nThis ID is provided by the API if\ \ `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it\ \ has to be added to the trust policy of the IAM role `roleArn` configured\ \ above, otherwise the API won't be able to write to the S3 bucket.\ \ An appropriate trust policy would look like this:\n\n```\n{\n \"\ Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\ \n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"\ StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n \ \ }\n }\n}\n```\n\nwhere \"{{externalId}}\" is the generated ID.\n\ \nThis property is optional but we recommend it as an additional security\ \ feature. We will use both the `roleArn` and the `externalId` to access\ \ your S3 data.\nIf the Amazon IAM role has an external ID configured\ \ but it is not provided in the output configuration Bitmovin won't\ \ be able to write to the S3 bucket. Also if the\nexternal ID does not\ \ match the one configured for the IAM role on AWS side, Bitmovin won't\ \ be able to access the S3 bucket.\n\nIf you need to change the external\ \ ID that is used by your IAM role, you need to create a new output,\ \ and use the external ID provided by the API to update your IAM role.\n\ \nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\n" example: fe8e171b-1953-452c-a3b5-b098c534d71c externalIdMode: allOf: - $ref: '#/components/schemas/ExternalIdMode' md5MetaTag: type: string description: If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file. example: my-md5-checksum-tag cloudRegion: allOf: - $ref: '#/components/schemas/AwsCloudRegion' signatureVersion: allOf: - $ref: '#/components/schemas/S3SignatureVersion' description: Specifies the method used for authentication example: S3_V4 SftpOutput: title: SftpOutput required: - host allOf: - $ref: '#/components/schemas/Output' - properties: host: type: string description: Host Url or IP of the SFTP server example: bitmovin.com port: type: integer description: 'Port to use, standard for SFTP: 22' example: 22 passive: type: boolean description: Use passive mode. Default is true. example: true username: type: string description: Your SFTP Username example: encodingInputUser writeOnly: true password: type: string description: Your SFTP password example: 3nc0d3d! writeOnly: true transferVersion: description: Controls which transfer version should be used allOf: - $ref: '#/components/schemas/TransferVersion' maxConcurrentConnections: type: integer description: Restrict maximum concurrent connections. Requires at least version 1.1.0. example: 20 EncodingTemplateRequest: description: "The template request object can be either a string (YAML/JSON)\ \ or a generic object that includes all the fields. \nPlease note that when\ \ sending the request as an object, the order of the fields is important,\ \ as it determines the sequence in which the Encoding resources are created.\n" type: object EncodingTemplateResponse: title: EncodingTemplateResponse required: - type allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: type: allOf: - $ref: '#/components/schemas/EncodingTemplateType' EncodingTemplateDetails: title: EncodingTemplateDetails required: - url allOf: - $ref: '#/components/schemas/EncodingTemplateResponse' - properties: url: readOnly: true type: string description: The url to download the template file example: https://storage.bitmovin.com/path/to/your/template.yml EncodingTemplateType: title: EncodingTemplateType description: The Encoding Template type type: string enum: - VOD - LIVE example: VOD x-enum-elements: - name: VOD description: VOD Encoding Template - name: LIVE description: Live Encoding Template EncodingTemplateStartResponse: title: EncodingTemplateStartResponse required: - encodingId properties: encodingId: type: string readOnly: true description: Id of the Encoding that is created example: 7cbb69ed-83f9-40a4-a162-a66e570ce910 Notification: title: Notification allOf: - $ref: '#/components/schemas/BitmovinResponse' - properties: resolve: type: boolean description: Notify when condition resolves after it was met example: 'true' resourceId: type: string description: Specific resource, e.g. encoding id triggeredAt: type: string format: date-time readOnly: true description: Last time the notification was triggered example: '2016-06-25T20:09:23.69Z' type: type: string example: EMAIL eventType: type: string example: LIVE_INPUT_STREAM_CHANGED readOnly: true category: type: string example: ENCODING readOnly: true resourceType: type: string example: ENCODING readOnly: true muted: type: boolean customData: type: string writeOnly: true description: User-specific meta data. This can hold anything. additionalProperties: type: object EmailNotification: title: EmailNotification required: - emails allOf: - $ref: '#/components/schemas/Notification' - properties: type: type: string example: EMAIL readOnly: true emails: type: array items: type: string example: - account@bitmovin.com EncodingErrorEmailNotification: title: EncodingErrorEmailNotification allOf: - $ref: '#/components/schemas/EmailNotification' - properties: eventType: type: string readOnly: true category: type: string readOnly: true resourceType: type: string readOnly: true PaginationResponse: title: PaginationResponse properties: totalCount: type: integer format: int64 readOnly: true offset: type: integer readOnly: true limit: type: integer readOnly: true previous: type: string readOnly: true next: type: string readOnly: true items: type: array readOnly: true items: type: object AbstractCondition: title: AbstractCondition EmailNotificationWithStreamConditions: title: EmailNotificationWithStreamConditions required: - emails allOf: - $ref: '#/components/schemas/EmailNotification' - properties: resolve: type: boolean default: true description: Notify when condition resolves after it was met conditions: allOf: - $ref: '#/components/schemas/AbstractCondition' EmailNotificationWithStreamConditionsRequest: title: EmailNotificationWithStreamConditionsRequest required: - emails - conditions properties: resolve: type: boolean default: true description: Notify when condition resolves after it was met emails: type: array items: type: string muted: type: boolean conditions: allOf: - $ref: '#/components/schemas/AbstractCondition' SignatureType: title: SignatureType type: string enum: - HMAC Webhook: title: Webhook required: - url allOf: - $ref: '#/components/schemas/BitmovinResource' - properties: url: type: string description: Webhook URL example: https://yourendpoint.yourcorp.com/webhooks/encoding/finished method: description: HTTP method used for the webhook allOf: - $ref: '#/components/schemas/WebhookHttpMethod' insecureSsl: type: boolean description: Skip verification of the SSL certificate example: false signature: description: Signature used for the webhook allOf: - $ref: '#/components/schemas/WebhookSignature' schema: readOnly: true description: JSON schema of the webhook payload example: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\ ,\n \"title\": \"Encoding Webhook Event\",\n \"type\": \"object\"\ ,\n \"additionalProperties\": false,\n \"properties\": {\n \"id\"\ : {\n \"type\": \"string\"\n },\n \"eventId\": {\n \"\ type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"\ string\",\n \"format\": \"date-time\"\n },\n \"modifiedAt\"\ : {\n \"type\": \"string\",\n \"format\": \"date-time\"\n\ \ },\n \"orgId\": {\n \"type\": \"string\"\n },\n \"\ userId\": {\n \"type\": \"string\"\n },\n \"name\": {\n \ \ \"type\": \"string\"\n },\n \"notificationId\": {\n \ \ \"type\": \"string\"\n },\n \"resourceId\": {\n \"type\"\ : \"string\"\n },\n \"resourceType\": {\n \"type\": \"string\"\ ,\n \"enum\": [\n \"NONE\",\n \"ENCODING\"\n \ \ ]\n },\n \"type\": {\n \"type\": \"string\",\n \"\ enum\": [\n \"EMAIL\",\n \"WEBHOOK\"\n ]\n },\n\ \ \"eventType\": {\n \"type\": \"string\",\n \"enum\":\ \ [\n \"MANIFEST_ERROR\",\n \"USAGE_REPORT\",\n \ \ \"ENCODING_ERROR\",\n \"PRODUCT_USAGE_QUOTA_ALERT\",\n \ \ \"LIVE_INPUT_STREAM_CHANGED\",\n \"LIVE_ENCODING_HEARTBEAT\"\ ,\n \"MANIFEST_FINISHED\",\n \"ENCODING_TRANSFER_ERROR\"\ ,\n \"PRODUCT_USAGE_PREDICTION_ALERT\",\n \"ENCODING_FINISHED\"\ ,\n \"LIVE_MANIFEST_READY\"\n ]\n },\n \"category\"\ : {\n \"type\": \"string\",\n \"enum\": [\n \"USAGE_REPORT\"\ ,\n \"PRODUCT_USAGE_PREDICTION\",\n \"ENCODING\",\n \ \ \"PRODUCT_USAGE_QUOTA\",\n \"MANIFEST\"\n ]\n \ \ },\n \"state\": {\n \"type\": \"string\",\n \"enum\"\ : [\n \"FIRED\",\n \"RESOLVED\"\n ]\n },\n \ \ \"triggeredAt\": {\n \"type\": \"string\",\n \"format\"\ : \"date-time\"\n },\n \"triggeredForResourceId\": {\n \"\ type\": \"string\"\n },\n \"internal\": {\n \"type\": \"\ boolean\"\n },\n \"purpose\": {\n \"type\": \"string\",\n\ \ \"enum\": []\n },\n \"customData\": {},\n \"encoding\"\ : {\n \"$ref\": \"#/definitions/EncodingDTO\"\n },\n \"webhookId\"\ : {\n \"type\": \"string\"\n }\n },\n \"definitions\": {\n\ \ \"EncodingDTO\": {\n \"type\": \"object\",\n \"additionalProperties\"\ : false,\n \"properties\": {\n \"id\": {\n \"type\"\ : \"string\"\n },\n \"type\": {\n \"type\": \"\ string\"\n },\n \"name\": {\n \"type\": \"string\"\ \n },\n \"description\": {\n \"type\": \"string\"\ \n },\n \"encoderVersion\": {\n \"type\": \"\ string\"\n },\n \"cloudRegion\": {\n \"type\"\ : \"string\"\n }\n }\n }\n }\n}\n" WebhookHttpMethod: title: WebhookHttpMethod type: string enum: - POST - PUT WebhookSignature: title: WebhookSignature required: - type - key properties: type: description: 'The signature type used for the webhook. Selects one of the supported signatures. The signature is attached to the list of headers with the key `Bitmovin-Signature`. In case of the `HMAC` type the SHA512 hashing algorithm is used to generate an authentication code from the webhook body. ' example: HMAC allOf: - $ref: '#/components/schemas/SignatureType' key: type: string description: The key of the signature writeOnly: true example: secretKey WebhookNotification: title: WebhookNotification required: - url allOf: - $ref: '#/components/schemas/Notification' - properties: type: type: string example: WEBHOOK readOnly: true url: type: string example: https://www.example.com/my/webhook/endpoint description: The destination URL where the webhook data is send to method: description: HTTP method used for the webhook allOf: - $ref: '#/components/schemas/WebhookHttpMethod' insecureSsl: type: boolean description: Skip verification of the SSL certificate example: false signature: description: Signature used for the webhook allOf: - $ref: '#/components/schemas/WebhookSignature' WebhookNotificationWithStreamConditionsRequest: title: WebhookNotificationWithStreamConditionsRequest allOf: - $ref: '#/components/schemas/WebhookNotification' - properties: resolve: type: boolean default: true description: Notify when the given conditions are resolved. E.g. when the input stream is online again after a disconnect conditions: allOf: - $ref: '#/components/schemas/AbstractCondition' WebhookNotificationWithStreamConditions: title: WebhookNotificationWithStreamConditions allOf: - $ref: '#/components/schemas/WebhookNotification' - properties: resolve: type: boolean default: true description: Notify when condition resolves after it was met conditions: allOf: - $ref: '#/components/schemas/AbstractCondition' LiveEncodingHeartbeatWebhook: title: LiveEncodingHeartbeatWebhook allOf: - $ref: '#/components/schemas/Webhook' - properties: interval: type: integer minimum: 1 default: 20 description: The interval of the heartbeat in seconds. example: 20 schema: readOnly: true description: JSON schema of the webhook payload example: "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\ ,\n \"title\": \"Live Encoding Heartbeat Webhook Event\",\n \"type\"\ : \"object\",\n \"additionalProperties\": false,\n \"properties\"\ : {\n \"id\": {\n \"type\": \"string\"\n },\n \"orgId\"\ : {\n \"type\": \"string\"\n },\n \"userId\": {\n \"\ type\": \"string\"\n },\n \"resourceId\": {\n \"type\": \"\ string\"\n },\n \"resourceType\": {\n \"type\": \"string\"\ ,\n \"enum\": [\n \"NONE\",\n \"ENCODING\"\n \ \ ]\n },\n \"eventType\": {\n \"type\": \"string\",\n \ \ \"enum\": [\n \"LIVE_ENCODING_HEARTBEAT\"\n ]\n \ \ },\n \"triggeredAt\": {\n \"type\": \"string\",\n \"\ format\": \"date-time\"\n },\n \"customData\": {},\n \"encoding\"\ : {\n \"$ref\": \"#/definitions/EncodingDTO\"\n },\n \"webhookId\"\ : {\n \"type\": \"string\"\n },\n \"value\": {\n \"\ type\": \"object\",\n \"properties\": {\n \"ingest\": {\n\ \ \"type\": \"object\",\n \"properties\": {\n \ \ \"status\": {\n \"type\": \"string\"\n \ \ },\n \"healthy\": {\n \"type\": \"boolean\"\ \n },\n \"streamInfos\": {\n \"type\"\ : \"array\",\n \"items\": {\n \"type\":\ \ \"object\",\n \"properties\": {\n \ \ \"streamId\": {\n \"type\": \"string\"\n \ \ },\n \"mediaType\": {\n \ \ \"type\": \"string\"\n },\n \ \ \"width\": {\n \"type\": \"integer\"\n \ \ },\n \"height\": {\n \ \ \"type\": \"integer\"\n },\n \"\ rate\": {\n \"type\": \"integer\"\n \ \ },\n \"codec\": {\n \"type\"\ : \"string\"\n },\n \"bitrate\": {\n\ \ \"type\": \"integer\"\n },\n \ \ \"samplesReadPerSecondAvg\": {\n \ \ \"type\": \"number\"\n },\n \"\ incomingBitrate\": {\n \"type\": \"number\"\n \ \ },\n \"lastTimestampTimescale\": {\n\ \ \"type\": \"integer\"\n },\n \ \ \"lastArrivalTime\": {\n \"type\"\ : \"string\",\n \"format\": \"date-time\"\n \ \ },\n \"healthy\": {\n \ \ \"type\": \"boolean\"\n }\n }\n\ \ }\n }\n }\n }\n }\n \ \ }\n },\n \"definitions\": {\n \"EncodingDTO\": {\n \"\ type\": \"object\",\n \"additionalProperties\": false,\n \"\ properties\": {\n \"id\": {\n \"type\": \"string\"\n\ \ },\n \"type\": {\n \"type\": \"string\"\n \ \ },\n \"name\": {\n \"type\": \"string\"\n \ \ },\n \"description\": {\n \"type\": \"string\"\ \n },\n \"encoderVersion\": {\n \"type\": \"\ string\"\n },\n \"cloudRegion\": {\n \"type\"\ : \"string\"\n }\n }\n }\n }\n}\n" RtmpIngestPoint: title: RtmpIngestPoint required: - applicationName - streamKey properties: applicationName: type: string description: The name of the application where the ingest is streamed to. This has to be unique for each ingest point example: live streamKey: type: string description: The stream key for the backup input example: myStream UpdateEncodingRtmpIngestPointRequest: title: UpdateEncodingRtmpIngestPointRequest properties: ingestPoints: type: array description: 'List of ingest points to be updated for the encoding. The RTMPs application name and streamKey will be assigned to the encoding. ' items: $ref: '#/components/schemas/RtmpIngestPoint' UpdateEncodingRtmpIngestPointResponse: title: UpdateEncodingRtmpIngestPointResponse type: object properties: {}