swagger: '2.0'
info:
description: The Kaltura OTT API
title: Kaltura OTT accessControl baseEntry 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: Base Entry Service
name: baseEntry
paths:
/service/baseentry/action/add:
post:
description: Generic add entry, should be used when the uploaded entry type is not known.
operationId: baseEntry.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:
entry:
$ref: '#/definitions/KalturaBaseEntry'
type:
enum:
- '-1'
- conference.CONFERENCE_ENTRY_SERVER
- externalMedia.externalMedia
- sip.SIP_ENTRY_SERVER
- '1'
- '2'
- '5'
- '6'
- '7'
- '8'
- '10'
type: string
x-enumLabels:
- AUTOMATIC
- CONFERENCE_ENTRY_SERVER
- EXTERNAL_MEDIA
- SIP_ENTRY_SERVER
- MEDIA_CLIP
- MIX
- PLAYLIST
- DATA
- LIVE_STREAM
- LIVE_CHANNEL
- DOCUMENT
x-enumType: KalturaEntryType
required:
- entry
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_TYPE_NOT_SUPPORTED`: Entry type "@ENTRY_TYPE@" not supported'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entry
- type
/service/baseentry/action/addContent:
post:
description: Attach content resource to entry in status NO_MEDIA
operationId: baseEntry.addContent
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:
entryId:
type: string
resource:
$ref: '#/definitions/KalturaResource'
required:
- entryId
- resource
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_TYPE_NOT_SUPPORTED`: Entry type "@ENTRY_TYPE@" not supported'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- resource
/service/baseentry/action/addFromUploadedFile:
post:
description: Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.
operationId: baseEntry.addFromUploadedFile
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:
entry:
$ref: '#/definitions/KalturaBaseEntry'
type:
enum:
- '-1'
- conference.CONFERENCE_ENTRY_SERVER
- externalMedia.externalMedia
- sip.SIP_ENTRY_SERVER
- '1'
- '2'
- '5'
- '6'
- '7'
- '8'
- '10'
type: string
x-enumLabels:
- AUTOMATIC
- CONFERENCE_ENTRY_SERVER
- EXTERNAL_MEDIA
- SIP_ENTRY_SERVER
- MEDIA_CLIP
- MIX
- PLAYLIST
- DATA
- LIVE_STREAM
- LIVE_CHANNEL
- DOCUMENT
x-enumType: KalturaEntryType
uploadTokenId:
type: string
required:
- entry
- uploadTokenId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entry
- uploadTokenId
- type
/service/baseentry/action/anonymousRank:
post:
description: Anonymously rank an entry, no validation is done on duplicate rankings.
operationId: baseEntry.anonymousRank
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:
entryId:
type: string
rank:
type: integer
required:
- entryId
- rank
type: object
responses:
'200':
description: Success
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- rank
/service/baseentry/action/approve:
post:
description: Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).
operationId: baseEntry.approve
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:
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
/service/baseentry/action/clone:
post:
description: Clone an entry with optional attributes to apply to the clone
operationId: baseEntry.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:
cloneOptions:
items:
$ref: '#/definitions/KalturaBaseEntryCloneOptionItem'
type: array
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- cloneOptions
/service/baseentry/action/count:
post:
description: Count base entries by filter.
operationId: baseEntry.count
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/KalturaBaseEntryFilter'
type: object
responses:
'200':
description: Success
schema:
type: integer
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- filter
/service/baseentry/action/delete:
post:
description: Delete an entry.
operationId: baseEntry.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:
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
/service/baseentry/action/export:
post:
operationId: baseEntry.export
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:
entryId:
type: string
storageProfileId:
type: integer
required:
- entryId
- storageProfileId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `STORAGE_PROFILE_ID_NOT_FOUND`: Storage profile id @ID@ not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- storageProfileId
/service/baseentry/action/exportToCsv:
post:
description: add batch job that sends an email with a link to download an updated CSV that contains list of entries
operationId: baseEntry.exportToCsv
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:
additionalFields:
items:
$ref: '#/definitions/KalturaCsvAdditionalFieldInfo'
type: array
filter:
$ref: '#/definitions/KalturaBaseEntryFilter'
mappedFields:
items:
$ref: '#/definitions/KalturaKeyValue'
type: array
metadataProfileId:
type: integer
options:
$ref: '#/definitions/KalturaExportToCsvOptions'
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- filter
- metadataProfileId
- additionalFields
- mappedFields
- options
/service/baseentry/action/flag:
post:
description: Flag inappropriate entry for moderation.
operationId: baseEntry.flag
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:
moderationFlag:
$ref: '#/definitions/KalturaModerationFlag'
required:
- moderationFlag
type: object
responses:
'200':
description: Success
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- moderationFlag
/service/baseentry/action/get:
post:
description: Get base entry by ID.
operationId: baseEntry.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:
entryId:
type: string
version:
default: -1
type: integer
required:
- entryId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- version
/service/baseentry/action/getByIds:
post:
description: Get an array of KalturaBaseEntry objects by a comma-separated list of ids.
operationId: baseEntry.getByIds
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:
entryIds:
type: string
required:
- entryIds
type: object
responses:
'200':
description: Success
schema:
items:
$ref: '#/definitions/KalturaBaseEntry'
type: array
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryIds
/service/baseentry/action/getContextData:
post:
description: 'This action delivers entry-related data, based on the user''s context: access control, restriction, playback format and storage information.'
operationId: baseEntry.getContextData
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:
contextDataParams:
$ref: '#/definitions/KalturaEntryContextDataParams'
entryId:
type: string
required:
- entryId
- contextDataParams
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaEntryContextDataResult'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- contextDataParams
/service/baseentry/action/getPlaybackContext:
post:
description: This action delivers all data relevant for player
operationId: baseEntry.getPlaybackContext
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:
contextDataParams:
$ref: '#/definitions/KalturaPlaybackContextOptions'
entryId:
type: string
required:
- entryId
- contextDataParams
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaPlaybackContext'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- contextDataParams
/service/baseentry/action/getRemotePaths:
post:
description: Get remote storage existing paths for the asset.
operationId: baseEntry.getRemotePaths
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:
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaRemotePathListResponse'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `ENTRY_NOT_READY`: Entry "@ENTRY_NAME@" is not ready'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
/service/baseentry/action/index:
post:
description: Index an entry by id.
operationId: baseEntry.index
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: string
shouldUpdate:
default: true
type: boolean
required:
- id
type: object
responses:
'200':
description: Success
schema:
type: integer
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- id
- shouldUpdate
/service/baseentry/action/list:
post:
description: List base entries by filter with paging support.
operationId: baseEntry.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/KalturaBaseEntryFilter'
pager:
$ref: '#/definitions/KalturaFilterPager'
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntryListResponse'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- filter
- pager
/service/baseentry/action/listByReferenceId:
post:
description: List base entries by filter according to reference id
operationId: baseEntry.listByReferenceId
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:
pager:
$ref: '#/definitions/KalturaFilterPager'
refId:
type: string
required:
- refId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntryListResponse'
x-Errors:
description: '* `MISSING_MANDATORY_PARAMETER`: Missing parameter "@PARAM_NAME@"'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- refId
- pager
/service/baseentry/action/listFlags:
post:
description: List all pending flags for the entry.
operationId: baseEntry.listFlags
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:
entryId:
type: string
pager:
$ref: '#/definitions/KalturaFilterPager'
required:
- entryId
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaModerationFlagListResponse'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- pager
/service/baseentry/action/reject:
post:
description: Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).
operationId: baseEntry.reject
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:
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
/service/baseentry/action/servePlaybackKey:
post:
description: This action serves HLS encrypted key if access control is validated
operationId: baseEntry.servePlaybackKey
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:
entryId:
type: string
required:
- entryId
type: object
responses:
'200':
description: Success
schema:
type: string
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
/service/baseentry/action/update:
post:
description: Update base entry. Only the properties that were set will be updated.
operationId: baseEntry.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:
baseEntry:
$ref: '#/definitions/KalturaBaseEntry'
entryId:
type: string
required:
- entryId
- baseEntry
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- baseEntry
/service/baseentry/action/updateContent:
post:
description: Update the content resource associated with the entry.
operationId: baseEntry.updateContent
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:
advancedOptions:
$ref: '#/definitions/KalturaEntryReplacementOptions'
conversionProfileId:
type: integer
entryId:
type: string
resource:
$ref: '#/definitions/KalturaResource'
required:
- entryId
- resource
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- resource
- conversionProfileId
- advancedOptions
/service/baseentry/action/updateThumbnailFromSourceEntry:
post:
description: Update entry thumbnail from a different entry by a specified time offset (in seconds).
operationId: baseEntry.updateThumbnailFromSourceEntry
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:
entryId:
type: string
sourceEntryId:
type: string
timeOffset:
type: integer
required:
- entryId
- sourceEntryId
- timeOffset
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `PERMISSION_DENIED_TO_UPDATE_ENTRY`: User can update only the entries he own, otherwise an admin session must be used'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- sourceEntryId
- timeOffset
/service/baseentry/action/updateThumbnailFromUrl:
post:
description: Update entry thumbnail using URL.
operationId: baseEntry.updateThumbnailFromUrl
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:
entryId:
type: string
url:
type: string
required:
- entryId
- url
type: object
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `PERMISSION_DENIED_TO_UPDATE_ENTRY`: User can update only the entries he own, otherwise an admin session must be used'
tags:
- baseEntry
x-kaltura-format: post
x-kaltura-parameters:
- entryId
- url
/service/baseentry/action/updateThumbnailJpeg:
post:
description: Update entry thumbnail using a raw jpeg file.
operationId: baseEntry.updateThumbnailJpeg
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- description: Media entry id
in: query
name: entryId
required: true
type: string
- description: Jpeg file data
in: formData
name: fileData
required: true
type: file
responses:
'200':
description: Success
schema:
$ref: '#/definitions/KalturaBaseEntry'
x-Errors:
description: '* `ENTRY_ID_NOT_FOUND`: Entry id "@ENTRY_ID@" not found
* `PERMISSION_DENIED_TO_UPDATE_ENTRY`: User can update only the entries he own, otherwise an admin session must be used'
tags:
- baseEntry
x-kaltura-format: file
x-kaltura-parameters:
- entryId
- fileData
/service/baseentry/action/upload:
post:
deprecated: true
description: Upload a file to Kaltura, that can be used to create an entry.
operationId: baseEntry.upload
parameters:
- $ref: '#/parameters/ks'
- $ref: '#/parameters/format'
- description: The file data
in: formData
name: fileData
required: true
type: file
responses:
'200':
description: Success
schema:
type: string
tags:
- baseEntry
x-kaltura-format: file
x-kaltura-parameters:
- fileData
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
# --- truncated at 32 KB (1485 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaltura/refs/heads/main/openapi/kaltura-baseentry-api-openapi.yml