Kaltura batchcontrol API

swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl batchcontrol API
  version: 3.6.287.20720
host: tvpapi-us-preprod.ott.kaltura.com
basePath: /api_v3
schemes:
- https
- http
produces:
- application/json
- text/xml
security:
- ks: []
tags:
- description: "batch service lets you handle different batch process from remote machines.\n As opposed to other objects in the system, locking mechanism is critical in this case.\n For this reason the GetExclusiveXX, UpdateExclusiveXX and FreeExclusiveXX actions are important for the system's integrity.\n In general - updating batch object should be done only using the UpdateExclusiveXX which in turn can be called only after \n acquiring a batch object properly (using  GetExclusiveXX).\n If an object was acquired and should be returned to the pool in it's initial state - use the FreeExclusiveXX action \n Terminology:\n LocationId\n ServerID\n ParternGroups"
  name: batchcontrol
paths:
  /service/batchcontrol/action/configLoaded:
    post:
      description: batch configLoaded action saves the configuration as loaded by a remote scheduler
      operationId: batchcontrol.configLoaded
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            configParam:
              type: string
            configParamPart:
              type: string
            configValue:
              type: string
            scheduler:
              $ref: '#/definitions/KalturaScheduler'
            workerConfigId:
              type: integer
            workerName:
              type: string
          required:
          - scheduler
          - configParam
          - configValue
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSchedulerConfig'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - scheduler
      - configParam
      - configValue
      - configParamPart
      - workerConfigId
      - workerName
  /service/batchcontrol/action/getCommand:
    post:
      description: batch getCommand action returns the command with its current status
      operationId: batchcontrol.getCommand
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            commandId:
              type: integer
          required:
          - commandId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - commandId
  /service/batchcontrol/action/getFullStatus:
    post:
      description: batch getFullStatus action returns the status of all schedulers and queues
      operationId: batchcontrol.getFullStatus
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaFullStatusResponse'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/batchcontrol/action/getOrCreateScheduler:
    post:
      operationId: batchcontrol.getOrCreateScheduler
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            scheduler:
              $ref: '#/definitions/KalturaScheduler'
          required:
          - scheduler
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaScheduler'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - scheduler
  /service/batchcontrol/action/kill:
    post:
      description: batch kill action forces stop of a batch on a remote scheduler
      operationId: batchcontrol.kill
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            batchIndex:
              type: integer
            cause:
              type: string
            workerId:
              type: integer
          required:
          - workerId
          - batchIndex
          - adminId
          - cause
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - workerId
      - batchIndex
      - adminId
      - cause
  /service/batchcontrol/action/listCommands:
    post:
      description: list batch control commands
      operationId: batchcontrol.listCommands
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            filter:
              $ref: '#/definitions/KalturaControlPanelCommandFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommandListResponse'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/batchcontrol/action/listSchedulers:
    post:
      description: list all Schedulers
      operationId: batchcontrol.listSchedulers
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSchedulerListResponse'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/batchcontrol/action/listWorkers:
    post:
      description: list all Workers
      operationId: batchcontrol.listWorkers
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSchedulerWorkerListResponse'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters: []
  /service/batchcontrol/action/reportStatus:
    post:
      description: batch reportStatus action saves the status attribute from a remote scheduler and returns pending commands for the scheduler
      operationId: batchcontrol.reportStatus
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            scheduler:
              $ref: '#/definitions/KalturaScheduler'
            schedulerStatuses:
              items:
                $ref: '#/definitions/KalturaSchedulerStatus'
              type: array
            workerQueueFilters:
              items:
                $ref: '#/definitions/KalturaWorkerQueueFilter'
              type: array
          required:
          - scheduler
          - schedulerStatuses
          - workerQueueFilters
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaSchedulerStatusResponse'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - scheduler
      - schedulerStatuses
      - workerQueueFilters
  /service/batchcontrol/action/setCommandResult:
    post:
      description: batch setCommandResult action saves the results of a command as received from a remote scheduler
      operationId: batchcontrol.setCommandResult
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            commandId:
              type: integer
            errorDescription:
              type: string
            status:
              enum:
              - 1
              - 2
              - 3
              - 4
              type: integer
              x-enumLabels:
              - PENDING
              - HANDLED
              - DONE
              - FAILED
              x-enumType: KalturaControlPanelCommandStatus
          required:
          - commandId
          - status
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - commandId
      - status
      - errorDescription
  /service/batchcontrol/action/setSchedulerConfig:
    post:
      description: batch sets a configuration parameter to be loaded by a scheduler
      operationId: batchcontrol.setSchedulerConfig
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            cause:
              type: string
            configParam:
              type: string
            configParamPart:
              type: string
            configValue:
              type: string
            schedulerId:
              type: integer
          required:
          - schedulerId
          - adminId
          - configParam
          - configValue
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - schedulerId
      - adminId
      - configParam
      - configValue
      - configParamPart
      - cause
  /service/batchcontrol/action/setWorkerConfig:
    post:
      description: batch sets a configuration parameter to be loaded by a worker
      operationId: batchcontrol.setWorkerConfig
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            cause:
              type: string
            configParam:
              type: string
            configParamPart:
              type: string
            configValue:
              type: string
            workerId:
              type: integer
          required:
          - workerId
          - adminId
          - configParam
          - configValue
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - workerId
      - adminId
      - configParam
      - configValue
      - configParamPart
      - cause
  /service/batchcontrol/action/startWorker:
    post:
      description: batch start action starts a job
      operationId: batchcontrol.startWorker
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            cause:
              type: string
            workerId:
              type: integer
          required:
          - workerId
          - adminId
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - workerId
      - adminId
      - cause
  /service/batchcontrol/action/stopScheduler:
    post:
      description: batch stop action stops a scheduler
      operationId: batchcontrol.stopScheduler
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            cause:
              type: string
            schedulerId:
              type: integer
          required:
          - schedulerId
          - adminId
          - cause
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - schedulerId
      - adminId
      - cause
  /service/batchcontrol/action/stopWorker:
    post:
      description: batch stop action stops a worker
      operationId: batchcontrol.stopWorker
      parameters:
      - $ref: '#/parameters/ks'
      - $ref: '#/parameters/format'
      - $ref: '#/parameters/clientTag'
      - $ref: '#/parameters/partnerId'
      - $ref: '#/parameters/language'
      - $ref: '#/parameters/responseProfile'
      - in: body
        name: body
        schema:
          properties:
            adminId:
              type: integer
            cause:
              type: string
            workerId:
              type: integer
          required:
          - workerId
          - adminId
          - cause
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaControlPanelCommand'
      tags:
      - batchcontrol
      x-kaltura-format: post
      x-kaltura-parameters:
      - workerId
      - adminId
      - cause
definitions:
  KalturaPushToNewsDistributionProfile:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfile'
    properties:
      basePath:
        type: string
      bodyXslt:
        type: string
      certificateKey:
        type: string
      host:
        type: string
      ips:
        type: string
      namedItem:
        type: string
      password:
        type: string
        x-inputType: password
      port:
        type: integer
      protocol:
        description: '`insertOnly`


          Enum Type: `KalturaDistributionProtocol`'
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 10
        type: integer
        x-enumLabels:
        - FTP
        - SCP
        - SFTP
        - HTTP
        - HTTPS
        - ASPERA
        x-enumType: KalturaDistributionProtocol
      recentNewsTimeInterval:
        type: integer
      username:
        type: string
    title: KalturaPushToNewsDistributionProfile
    type: object
  KalturaBatchJobListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaBatchJob'
        type: array
    title: KalturaBatchJobListResponse
    type: object
  KalturaUverseDistributionProfile:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfile'
    properties:
      channelCopyright:
        type: string
      channelDescription:
        type: string
      channelImageLink:
        type: string
      channelImageTitle:
        type: string
      channelImageUrl:
        type: string
      channelLanguage:
        type: string
      channelLink:
        type: string
      channelTitle:
        type: string
      feedUrl:
        description: '`readOnly`'
        readOnly: true
        type: string
      ftpHost:
        type: string
      ftpLogin:
        type: string
      ftpPassword:
        type: string
    title: KalturaUverseDistributionProfile
    type: object
  KalturaServerNode:
    anyOf:
    - $ref: '#/definitions/KalturaConferenceServerNode'
    - $ref: '#/definitions/KalturaSipServerNode'
    - $ref: '#/definitions/KalturaEdgeServerNode'
    - $ref: '#/definitions/KalturaLiveClusterMediaServerNode'
    - $ref: '#/definitions/KalturaWowzaMediaServerNode'
    description: '`abstract`'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      dc:
        description: '`readOnly`


          DC where the serverNode is located'
        readOnly: true
        type: integer
      description:
        type: string
      environment:
        description: Environment
        type: string
      heartbeatTime:
        description: '`readOnly`'
        readOnly: true
        type: integer
      hostName:
        description: serverNode hostName
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      name:
        description: serverNode name
        type: string
      objectType:
        enum:
        - KalturaConferenceServerNode
        - KalturaSipServerNode
        - KalturaEdgeServerNode
        - KalturaLiveClusterMediaServerNode
        - KalturaWowzaMediaServerNode
        type: string
      parentId:
        description: Id of the parent serverNode
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      status:
        description: '`readOnly`


          Enum Type: `KalturaServerNodeStatus`'
        enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        readOnly: true
        type: integer
        x-enumLabels:
        - ACTIVE
        - DISABLED
        - DELETED
        - NOT_REGISTERED
        - NOT_OPERATIONAL
        x-enumType: KalturaServerNodeStatus
      systemName:
        description: serverNode uniqe system name
        type: string
      tags:
        description: serverNode tags
        type: string
      type:
        description: '`readOnly`


          Enum Type: `KalturaServerNodeType`'
        enum:
        - conference.CONFERENCE_SERVER
        - liveCluster.LIVE_CLUSTER_MEDIA_SERVER
        - sip.SIP_SERVER
        - wowza.WOWZA_MEDIA_SERVER
        - '1'
        readOnly: true
        type: string
        x-enumLabels:
        - CONFERENCE_SERVER
        - LIVE_CLUSTER_MEDIA_SERVER
        - SIP_SERVER
        - WOWZA_MEDIA_SERVER
        - EDGE
        x-enumType: KalturaServerNodeType
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaServerNode
    type: object
    x-abstract: true
  KalturaIdeticDistributionProfileFilter:
    allOf:
    - $ref: '#/definitions/KalturaIdeticDistributionProfileBaseFilter'
    properties:
      orderBy:
        enum:
        - +createdAt
        - +updatedAt
        - -createdAt
        - -updatedAt
        type: string
        x-enumLabels:
        - CREATED_AT_ASC
        - UPDATED_AT_ASC
        - CREATED_AT_DESC
        - UPDATED_AT_DESC
        x-enumType: KalturaIdeticDistributionProfileOrderBy
    title: KalturaIdeticDistributionProfileFilter
    type: object
  KalturaQuizUserEntry:
    allOf:
    - $ref: '#/definitions/KalturaUserEntry'
    properties:
      calculatedScore:
        description: '`readOnly`'
        readOnly: true
        type: number
      feedback:
        type: string
      score:
        description: '`readOnly`'
        readOnly: true
        type: number
      version:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaQuizUserEntry
    type: object
  KalturaYahooDistributionProviderBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProviderFilter'
    anyOf:
    - $ref: '#/definitions/KalturaYahooDistributionProviderFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaYahooDistributionProviderFilter
        type: string
    title: KalturaYahooDistributionProviderBaseFilter
    type: object
    x-abstract: true
  KalturaEmailNotificationUserRecipientJobData:
    allOf:
    - $ref: '#/definitions/KalturaEmailNotificationRecipientJobData'
    description: JobData representing the dynamic user receipient array
    properties:
      filter:
        $ref: '#/definitions/KalturaUserFilter'
    title: KalturaEmailNotificationUserRecipientJobData
    type: object
  KalturaPodcastDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaPodcastDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaPodcastDistributionProfileFilter
        type: string
    title: KalturaPodcastDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaDrmProfile:
    anyOf:
    - $ref: '#/definitions/KalturaDrmProfile'
    - $ref: '#/definitions/KalturaFairplayDrmProfile'
    - $ref: '#/definitions/KalturaPlayReadyProfile'
    - $ref: '#/definitions/KalturaWidevineProfile'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      defaultPolicy:
        type: string
      description:
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      licenseServerUrl:
        type: string
      name:
        type: string
      objectType:
        enum:
        - KalturaDrmProfile
        - KalturaFairplayDrmProfile
        - KalturaPlayReadyProfile
        - KalturaWidevineProfile
        type: string
      partnerId:
        description: '`insertOnly`'
        type: integer
      provider:
        description: 'Enum Type: `KalturaDrmProviderType`'
        enum:
        - fairplay.FAIRPLAY
        - playReady.PLAY_READY
        - widevine.WIDEVINE
        - '1'
        type: string
        x-enumLabels:
        - FAIRPLAY
        - PLAY_READY
        - WIDEVINE
        - CENC
        x-enumType: KalturaDrmProviderType
      signingKey:
        type: string
      status:
        description: 'Enum Type: `KalturaDrmProfileStatus`'
        enum:
        - 1
        - 2
        type: integer
        x-enumLabels:
        - ACTIVE
        - DELETED
        x-enumType: KalturaDrmProfileStatus
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaDrmProfile
    type: object
  KalturaStorageProfile:
    anyOf:
    - $ref: '#/definitions/KalturaStorageProfile'
    - $ref: '#/definitions/KalturaAmazonS3StorageProfile'
    - $ref: '#/definitions/KalturaKontikiStorageProfile'
    discriminator: objectType
    properties:
      allowAutoDelete:
        description: Flag sugnifying that the storage exported content should be deleted when soure entry is deleted
        type: integer
      createFileLink:
        description: Indicates to the local file transfer manager to create a link to the file instead of copying it
        type: boolean
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      deliveryPriority:
        description: Delivery Priority
        type: integer
      deliveryProfileIds:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
      deliveryStatus:
        description: 'Enum Type: `KalturaStorageProfileDeliveryStatus`'
        enum:
        - 1
        - 2
        type: integer
        x-enumLabels:
        - ACTIVE
        - BLOCKED
        x-enumType: KalturaStorageProfileDeliveryStatus
      desciption:
        type: string
      excludedEntryTypes:
        type: string
      excludedFlavorParamsIds:
        type: string
      exportPeriodically:
        type: boolean
      flavorParamsIds:
        type: string
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      maxConcurrentConnections:
        type: integer
      maxFileSize:
        type: integer
      minFileSize:
        type: integer
      name:
        type: string
      objectType:
        enum:
        - KalturaStorageProfile
        - KalturaAmazonS3StorageProfile
        - KalturaKontikiStorageProfile
        type: string
      packagerUrl:
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      passPhrase:
        type: string
      pathManagerClass:
        type: string
      pathManagerParams:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
      pathPrefix:
        type: string
      port:
        type: integer
      privateKey:
        type: string
      protocol:
        description: 'Enum Type: `KalturaStorageProfileProtocol`'
        enum:
        - kontiki.KONTIKI
        - '0'
        - '1'
        - '2'
        - '3'
        - '6'
        - '7'
        type: string
        x-enumLabels:
        - KONTIKI
        - KALTURA_DC
        - FTP
        - SCP
        - SFTP
        - S3
        - LOCAL
        x-enumType: KalturaStorageProfileProtocol
      publicKey:
        type: string
      readyBehavior:
        description: 'Enum Type: `KalturaStorageProfileReadyBehavior`'
        enum:
        - 0
        - 1
        type: integer
        x-enumLabels:
        - NO_IMPACT
        - REQUIRED
        x-enumType: KalturaStorageProfileReadyBehavior
      rules:
        items:
          $ref: '#/definitions/KalturaRule'
        type: array
      shouldExportCaptions:
        type: boolean
      shouldExportThumbs:
        type: boolean
      status:
        description: 'Enum Type: `KalturaStorageProfileStatus`'
        enum:
        - 1
        - 2
        - 3
        type: integer
        x-enumLabels:
        - DISABLED
        - AUTOMATIC
        - MANUAL
        x-enumType: KalturaStorageProfileStatus
      storageBaseDir:
        type: string
      storageFtpPassiveMode:
        type: boolean
      storagePassword:
        type: string
      storageUrl:
        type: string
      storageUsername:
        type: string
      systemName:
        type: string
      trigger:
        description: No need to create enum for temp field
        type: integer
      updatedAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
    title: KalturaStorageProfile
    type: object
  KalturaEntryVendorTaskCsvJobData:
    allOf:
    - $ref: '#/definitions/KalturaExportCsvJobData'
    properties:
      filter:
        $ref: '#/definitions/KalturaEntryVendorTaskFilter'
    title: KalturaEntryVendorTaskCsvJobData
    type: object
  KalturaUserLoginDataListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaUserLoginData'
        type: array
    title: KalturaUserLoginDataListResponse
    type: object
  KalturaMsnDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaConfigurableDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaMsnDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaMsnDistributionProfileFilter
        type: string
    title: KalturaMsnDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaUrlTokenizerCht:
    allOf:
    - $ref: '#/definitions/KalturaUrlTokenizer'
    properties: {}
    title: KalturaUrlTokenizerCht
    type: object
  KalturaFtpDropFolderBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaRemoteDropFolderFilter'
    anyOf:
    - $ref: '#/definitions/KalturaFtpDropFolderFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaFtpDropFolderFilter
        type: string
    title: KalturaFtpDropFolderBaseFilter
    type: object
    x-abstract: true
  KalturaAttUverseDistributionFile:
    properties:
      assetId:
        type: string
      assetType:
        description: 'Enum Type: `KalturaAssetType`'
        enum:
        - attachment.Attachment
        - caption.Caption
        - document.Document
        - document.Image
        - document.PDF
        - document.SWF
        - thumbCuePoint.timedThumb
        - transcript.Transcript
        - widevine.WidevineFlavor
        - '1'
        - '2'
        - '3'
        type: string
        x-enumLabels:
        - ATTACHMENT
        - CAPTION
        - DOCUMENT
        - IMAGE
        - PDF
        - SWF
        - TIMED_THUMB_ASSET
        - TRANSCRIPT
        - WIDEVINE_FLAVOR
        - FLAVOR
        - THUMBNAIL
        - LIVE
        x-enumType: KalturaAssetType
      localFilePath:
        type: string
      remoteFilename:
        type: string
    title: KalturaAttUverseDistributionFile
    type: object
  KalturaString:
    description: A string representation to return an array of strings
    properties:
      value:
        type: string
    title: KalturaString
    type: object
  KalturaDistributionProviderListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaDistributionProvider'
        type: array
    title: KalturaDistributionProviderListResponse
    type: object
  KalturaFreewheelDistributionProfileBaseFilter:
    allOf:
    - $ref: '#/definitions/KalturaDistributionProfileFilter'
    anyOf:
    - $ref: '#/definitions/KalturaFreewheelDistributionProfileFilter'
    description: '`abstract`'
    discriminator: objectType
    properties:
      objectType:
        enum:
        - KalturaFreewheelDistributionProfileFilter
        type: string
    title: KalturaFreewheelDistributionProfileBaseFilter
    type: object
    x-abstract: true
  KalturaScheduleEventResourceListResponse:
    allOf:
    - $ref: '#/definitions/KalturaListResponse'
    properties:
      objects:
        items:
          $ref: '#/definitions/KalturaScheduleEventResource'
        type: array
    title: KalturaScheduleEventResourceListResponse
    type: object
  KalturaThumbAssetFilter:
    allOf:
    - $ref: '#/definitions/KalturaThumbAssetBaseFilter'
    anyOf:
    - $ref: '#/definitions/KalturaThumbAssetFilter'
    - $ref: '#/definitions/KalturaTimedThumbAssetFilter'
    discriminator: objectType
    properti

# --- truncated at 32 KB (1471 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-batchcontrol-api-openapi.yml