Bitmovin Inputs API
The Inputs API from Bitmovin — 22 operation(s) for inputs.
The Inputs API from Bitmovin — 22 operation(s) for inputs.
openapi: 3.0.1
info:
title: Bitmovin Encoding Config Inputs 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: []
tags:
- name: Inputs
paths:
/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/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'
components:
schemas:
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
AdMarkersSource:
title: AdMarkersSource
type: string
enum:
- MANIFEST
- SEGMENTS
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
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'
S3SignatureVersion:
title: S3SignatureVersion
type: string
enum:
- S3_V2
- S3_V4
default: S3_V4
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
BitmovinResponse:
title: BitmovinResponse
required:
- id
properties:
id:
type: string
readOnly: true
description: Id of the resource
example: cb90b80c-8867-4e3b-8479-174aa2843f62
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
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
descriptio
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitmovin/refs/heads/main/openapi/bitmovin-inputs-api-openapi.yml