Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura recording API

The recording API from Kaltura — 6 operation(s) for recording.

Kaltura recording API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include recording. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 6 operations across 6 paths, and defines 64 schemas. It is described by OpenAPI 2.0, at version 3.6.287.20720.

Requests are made against the base URL https://www.kaltura.com/api_v3.

6 operations 6 paths 64 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.6.287.20720
Base URL
https://www.kaltura.com/api_v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kaltura recording API declares 1 security scheme for authenticating requests. An API key is passed in the body as ks (ks). By default, every request must be authenticated.

  • ks — A Kaltura session ID

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

recording 6
POST
/service/recording/action/add
Issue a record request for a program
recording.add 1 param → 200x-Errors
POST
/service/recording/action/cancel
Cancel a previously requested recording. Cancel recording can be called for recording in status Scheduled or Recording Only
recording.cancel 1 param → 200x-Errors
POST
/service/recording/action/delete
Delete one or more user recording(s). Delete recording can be called only for recordings in status Recorded
recording.delete 1 param → 200x-Errors
POST
/service/recording/action/get
Returns recording object by internal identifier
recording.get 1 param → 200x-Errors
POST
/service/recording/action/list
Return a list of recordings for the household with optional filter by status and KSQL.
recording.list 1 param → 200x-Errors
POST
/service/recording/action/protect
Protects an existing recording from the cleanup process for the defined protection period
recording.protect 1 param → 200x-Errors

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are KalturaRecording (8 properties), KalturaProductPriceFilter (6 properties), KalturaAssetHistoryFilter (5 properties), KalturaSocialCommentFilter (5 properties). Each schema is shown below with its type and property counts.

KalturaAssetReminderFilter
object
1 property
KalturaSeasonsReminderFilter
object
3 properties
KalturaSocialActionFilter
object
4 properties
KalturaPersonalFeedFilter
object
1 property
KalturaConfigurationGroupTagFilter
object
Configuration group tag filter
2 properties
KalturaSocialCommentFilter
object
5 properties
KalturaPersistedFilter
object
abstract
2 properties
KalturaInboxMessageFilter
object
4 properties
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaCountryFilter
object
Country filter
4 properties
KalturaRecordingListResponse
object
Recordings info wrapper
1 property
KalturaFilter
object
abstract
2 properties
OTTRequest
object
2 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaAnnouncementFilter
object
order announcements
1 property
KalturaSubscriptionFilter
object
4 properties
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaRegionFilter
object
2 properties
KalturaCurrencyFilter
object
Currency filter
2 properties
KalturaFilterPager
object
The KalturaFilterPager object enables paging management to be applied upon service list actions
2 properties
KalturaOTTUserFilter
object
OTT User filter
4 properties
KalturaImageTypeFilter
object
3 properties
KalturaSeriesReminderFilter
object
3 properties
KalturaEngagementFilter
object
3 properties
KalturaParentalRuleFilter
object
2 properties
KalturaImageFilter
object
5 properties
KalturaReminderFilter
object
abstract
1 property
KalturaAssetHistoryFilter
object
5 properties
KalturaAssetFilter
object
2 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaTopicFilter
object
1 property
KalturaMediaFileFilter
object
3 properties
KalturaSocialFriendActivityFilter
object
4 properties
KalturaReportFilter
object
abstract Report filter
2 properties
KalturaDeviceReportFilter
object
Report filter
1 property
KalturaUserAssetRuleFilter
object
User asset rule filter
3 properties
KalturaBookmarkFilter
object
Filtering Assets requests
3 properties
KalturaUserRoleFilter
object
User roles filter
3 properties
KalturaRecordingFilter
object
Filtering recordings
3 properties
KalturaConfigurationsFilter
object
Configuration filter
2 properties
KalturaPriceDetailsFilter
object
2 properties
KalturaSeriesRecordingFilter
object
Filtering recordings
1 property
KalturaFavoriteFilter
object
Favorite request filter
4 properties
KalturaMetaFilter
object
Meta filter
5 properties
KalturaHouseholdDeviceFilter
object
3 properties
KalturaLanguageFilter
object
Language filter
2 properties
KalturaChannelsFilter
object
4 properties
KalturaSubscriptionSetFilter
object
4 properties
KalturaTagFilter
object
5 properties
KalturaRecording
object
8 properties
KalturaAssetStructFilter
object
Filtering Asset Structs
4 properties
KalturaSearchHistoryFilter
object
1 property
KalturaProductPriceFilter
object
6 properties
KalturaHouseholdUserFilter
object
2 properties
KalturaDynamicOrderBy
object
Kaltura Asset Order
2 properties
KalturaAssetCommentFilter
object
3 properties
KalturaRelatedObjectFilter
object
abstract Define KalturaRelatedObjectFilter
1 property
KalturaConfigurationGroupDeviceFilter
object
Configuration group device filter
2 properties
KalturaPricePlanFilter
object
2 properties
KalturaTransactionHistoryFilter
object
Transactions filter
4 properties
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-recording-api-openapi.yml Raw ↑

Other APIs Kaltura publishes across the network.

Kaltura accessControl API
Kaltura accessControlProfile API
Kaltura adminUser API
Kaltura analytics API
Kaltura annotation API
Kaltura announcement API
Kaltura appToken API
Kaltura aspera API
Kaltura asset API
Kaltura assetComment API
Kaltura assetFile API
Kaltura assetHistory API