Kaltura entitlement API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include entitlement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.
This API exposes
10 operations
across 10 paths,
and defines 66 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.
10 operations10 paths66 schemas10 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 entitlement 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 10
Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.
entitlement 10
POST
/service/entitlement/action/cancel
Immediately cancel a subscription, PPV or collection. Cancel is possible only if within cancellation window and content not already consumed
entitlement.cancel1 param→ 200x-Errors
POST
/service/entitlement/action/cancelRenewal
Cancel a household service subscription at the next renewal. The subscription stays valid till the next renewal.
Reconcile the user household's entitlements with an external entitlements source. This request is frequency protected to avoid too frequent calls per household.
entitlement.externalReconcile1 param→ 200x-Errors
POST
/service/entitlement/action/forceCancel
Immediately cancel a subscription, PPV or collection. Cancel applies regardless of cancellation window and content consumption status
entitlement.forceCancel1 param→ 200x-Errors
POST
/service/entitlement/action/getNextRenewal
Returns the data about the next renewal
entitlement.getNextRenewal1 param→ 200
POST
/service/entitlement/action/grant
Grant household for an entitlement for a PPV or Subscription.
entitlement.grant1 param→ 200x-Errors
POST
/service/entitlement/action/list
Gets all the entitled media items for a household
entitlement.list1 param→ 200
POST
/service/entitlement/action/swap
Swap current entitlement (subscription) with new entitlement (subscription) - only Grant
entitlement.swap1 param→ 200
POST
/service/entitlement/action/update
Update Kaltura Entitelment by Purchase id
entitlement.update1 param→ 200
Schemas 66
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are KalturaEntitlement (14 properties), KalturaProductPriceFilter (6 properties), KalturaTagFilter (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
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaInboxMessageFilter
object
4 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaCountryFilter
object
Country filter
4 properties
KalturaFilter
object
abstract
2 properties
OTTRequest
object
2 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaEntitlement
object
Entitlement
14 properties
KalturaSubscriptionFilter
object
4 properties
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaAnnouncementFilter
object
order announcements
1 property
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
KalturaEntitlementRenewal
object
4 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaTopicFilter
object
1 property
KalturaEntitlementListResponse
object
Entitlements list
1 property
KalturaSocialFriendActivityFilter
object
4 properties
KalturaMediaFileFilter
object
3 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
KalturaPrice
object
Price
4 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
KalturaAssetFilter
object
2 properties
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
