Kaltura

Kaltura eventNotificationTemplate API

Event notification template service lets you create and manage event notification templates

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.kaltura.com/api-docs/
📖
Authentication
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Kaltura_API_Authentication_and_Security.html
📖
GettingStarted
https://developer.kaltura.com/api-docs/VPaaS-API-Getting-Started/Getting-Started-VPaaS-API.html
📖
Documentation
https://devdocs.api.ott.kaltura.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-eventnotificationtemplate-api-openapi.yml

Other Resources

🔗
Console
https://developer.kaltura.com/console
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/graphql/kaltura-graphql.md

OpenAPI Specification

kaltura-eventnotificationtemplate-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  description: The Kaltura OTT API
  title: Kaltura OTT accessControl eventNotificationTemplate 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: Event notification template service lets you create and manage event notification templates
  name: eventNotificationTemplate
  x-plugin: eventNotification
paths:
  /service/eventnotification_eventnotificationtemplate/action/add:
    post:
      description: This action allows for the creation of new backend event types in the system. This action requires access to the Kaltura server Admin Console. If you're looking to register to existing event types, please use the clone action instead.
      operationId: eventNotificationTemplate.add
      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:
            eventNotificationTemplate:
              $ref: '#/definitions/KalturaEventNotificationTemplate'
          required:
          - eventNotificationTemplate
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplate'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - eventNotificationTemplate
  /service/eventnotification_eventnotificationtemplate/action/clone:
    post:
      description: This action allows registering to various backend event. Use this action to create notifications that will react to events such as new video was uploaded or metadata field was updated. To see the list of available event types, call the listTemplates action.
      operationId: eventNotificationTemplate.clone
      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:
            eventNotificationTemplate:
              $ref: '#/definitions/KalturaEventNotificationTemplate'
            id:
              type: integer
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplate'
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found

            * `EVENT_NOTIFICATION_WRONG_TYPE`: Event notification template id [@ID@] is of type [@TYPE@]

            * `EVENT_NOTIFICATION_TEMPLATE_DUPLICATE_SYSTEM_NAME`: Event notification template with system name [@NAME@] already exists.'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - eventNotificationTemplate
  /service/eventnotification_eventnotificationtemplate/action/delete:
    post:
      description: Delete an event notification template object
      operationId: eventNotificationTemplate.delete
      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:
            id:
              type: integer
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
  /service/eventnotification_eventnotificationtemplate/action/dispatch:
    post:
      description: Dispatch event notification object by id
      operationId: eventNotificationTemplate.dispatch
      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:
            id:
              type: integer
            scope:
              $ref: '#/definitions/KalturaEventNotificationScope'
          required:
          - id
          - scope
          type: object
      responses:
        '200':
          description: Success
          schema:
            type: integer
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found

            * `EVENT_NOTIFICATION_DISPATCH_DISABLED`: Dispatching event notification template id [@ID@] is not allowed

            * `EVENT_NOTIFICATION_DISPATCH_FAILED`: Dispatching event notification template id [@ID@] failed'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - scope
  /service/eventnotification_eventnotificationtemplate/action/get:
    post:
      description: Retrieve an event notification template object by id
      operationId: eventNotificationTemplate.get
      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:
            id:
              type: integer
          required:
          - id
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplate'
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
  /service/eventnotification_eventnotificationtemplate/action/list:
    post:
      description: list event notification template objects
      operationId: eventNotificationTemplate.list
      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/KalturaEventNotificationTemplateFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplateListResponse'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/eventnotification_eventnotificationtemplate/action/listByPartner:
    post:
      operationId: eventNotificationTemplate.listByPartner
      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/KalturaPartnerFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplateListResponse'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/eventnotification_eventnotificationtemplate/action/listTemplates:
    post:
      description: Action lists the template partner event notification templates.
      operationId: eventNotificationTemplate.listTemplates
      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/KalturaEventNotificationTemplateFilter'
            pager:
              $ref: '#/definitions/KalturaFilterPager'
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplateListResponse'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - filter
      - pager
  /service/eventnotification_eventnotificationtemplate/action/register:
    post:
      description: Register to a queue from which event messages will be provided according to given template. Queue will be created if not already exists
      operationId: eventNotificationTemplate.register
      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:
            notificationTemplateSystemName:
              type: string
            pushNotificationParams:
              $ref: '#/definitions/KalturaPushNotificationParams'
          required:
          - notificationTemplateSystemName
          - pushNotificationParams
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaPushNotificationData'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - notificationTemplateSystemName
      - pushNotificationParams
  /service/eventnotification_eventnotificationtemplate/action/sendCommand:
    post:
      description: Clear queue messages
      operationId: eventNotificationTemplate.sendCommand
      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:
            command:
              enum:
              - CLEAR_QUEUE
              type: string
              x-enumLabels:
              - CLEAR_QUEUE
              x-enumType: KalturaPushNotificationCommandType
            notificationTemplateSystemName:
              type: string
            pushNotificationParams:
              $ref: '#/definitions/KalturaPushNotificationParams'
          required:
          - notificationTemplateSystemName
          - pushNotificationParams
          - command
          type: object
      responses:
        '200':
          description: Success
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - notificationTemplateSystemName
      - pushNotificationParams
      - command
  /service/eventnotification_eventnotificationtemplate/action/update:
    post:
      description: Update an existing event notification template object
      operationId: eventNotificationTemplate.update
      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:
            eventNotificationTemplate:
              $ref: '#/definitions/KalturaEventNotificationTemplate'
            id:
              type: integer
          required:
          - id
          - eventNotificationTemplate
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplate'
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - eventNotificationTemplate
  /service/eventnotification_eventnotificationtemplate/action/updateStatus:
    post:
      description: Update event notification template status by id
      operationId: eventNotificationTemplate.updateStatus
      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:
            id:
              type: integer
            status:
              enum:
              - 1
              - 2
              - 3
              type: integer
              x-enumLabels:
              - DISABLED
              - ACTIVE
              - DELETED
              x-enumType: KalturaEventNotificationTemplateStatus
          required:
          - id
          - status
          type: object
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/KalturaEventNotificationTemplate'
        x-Errors:
          description: '* `EVENT_NOTIFICATION_TEMPLATE_NOT_FOUND`: Event notification template id [@ID@] not found'
      tags:
      - eventNotificationTemplate
      x-kaltura-format: post
      x-kaltura-parameters:
      - id
      - status
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
  KalturaEventNotificationDispatchScope:
    allOf:
    - $ref: '#/definitions/KalturaEventNotificationScope'
    properties:
      dynamicValues:
        items:
          $ref: '#/definitions/KalturaKeyValue'
        type: array
    title: KalturaEventNotificationDispatchScope
    type: object
  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
    properties:
      objectType:
        enum:
        - KalturaThumbAssetFilter
        - KalturaTimedThumbAssetFilter
        type: string
      orderBy:
        enum:
        - +createdAt
        - +deletedAt
        - +size
        - +updatedAt
        - -createdAt
        - -deletedAt
        - -size
        - -updatedAt
        type: string
        x-enumLabels:
        - CREATED_AT_ASC
        - DELETED_AT_ASC
        - SIZE_ASC
        - UPDATED_AT_ASC
        - CREATED_AT_DESC
        - DELETED_AT_DESC
        - SIZE_DESC
        - UPDATED_AT_DESC
        x-enumType: KalturaThumbAssetOrderBy
    title: KalturaThumbAssetFilter
    type: object
  KalturaPermissionItem:
    anyOf:
    - $ref: '#/definitions/KalturaApiActionPermissionItem'
    - $ref: '#/definitions/KalturaApiParameterPermissionItem'
    description: '`abstract`'
    discriminator: objectType
    properties:
      createdAt:
        description: '`readOnly`'
        readOnly: true
        type: integer
      id:
        description: '`readOnly`'
        readOnly: true
        type: integer
      objectType:
        enum:
        - KalturaApiActionPermissionItem
        - KalturaApiParameterPermissionItem
        type: string
      partnerId:
        description: '`readOnly`'
        readOnly: true
        type: integer
      tags:
        type: string
      type:
        description: '`readOnly`


          Enum

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