Kaltura householdDevice API is one of 222 APIs that Kaltura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include householdDevice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.
This API exposes
9 operations
across 9 paths,
and defines 80 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.
9 operations9 paths80 schemas9 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 householdDevice 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 9
Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.
householdDevice 9
POST
/service/householddevice/action/add
Add device to household
householdDevice.add1 param→ 200x-Errors
POST
/service/householddevice/action/addByPin
Registers a device to a household using pin code
householdDevice.addByPin1 param→ 200x-Errors
POST
/service/householddevice/action/delete
Removes a device from household
householdDevice.delete1 param→ 200x-Errors
POST
/service/householddevice/action/generatePin
Generates device pin to use when adding a device to household by pin
householdDevice.generatePin1 param→ 200
POST
/service/householddevice/action/get
Returns device registration status to the supplied household
householdDevice.get1 param→ 200x-Errors
POST
/service/householddevice/action/list
Returns the devices within the household
householdDevice.list1 param→ 200x-Errors
POST
/service/householddevice/action/loginWithPin
User sign-in via a time-expired sign-in PIN.
householdDevice.loginWithPin1 param→ 200x-Errors
POST
/service/householddevice/action/update
Update the name of the device by UDID
householdDevice.update1 param→ 200x-Errors
POST
/service/householddevice/action/updateStatus
Update the name of the device by UDID
householdDevice.updateStatus1 param→ 200x-Errors
Schemas 80
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are KalturaOTTUser (14 properties), KalturaHouseholdDevice (8 properties), KalturaProductPriceFilter (6 properties), KalturaAssetHistoryFilter (5 properties). Each schema is shown below with its type and property counts.
KalturaConfigurationGroupTagFilter
object
Configuration group tag filter
2 properties
KalturaSocialActionFilter
object
4 properties
KalturaPersistedFilter
object
abstract
2 properties
KalturaCountryFilter
object
Country filter
4 properties
KalturaFilter
object
abstract
2 properties
KalturaRegionFilter
object
2 properties
KalturaOTTUserFilter
object
OTT User filter
4 properties
KalturaEngagementFilter
object
3 properties
KalturaDoubleValue
object
A string representation to return an array of doubles
1 property
KalturaReminderFilter
object
abstract
1 property
KalturaAssetHistoryFilter
object
5 properties
KalturaReportFilter
object
abstract Report filter
2 properties
KalturaPluginData
object
KalturaSeriesRecordingFilter
object
Filtering recordings
1 property
KalturaMetaFilter
object
Meta filter
5 properties
KalturaChannelsFilter
object
4 properties
KalturaAssetStructFilter
object
Filtering Asset Structs
4 properties
KalturaHouseholdDevice
object
Device details
8 properties
KalturaHouseholdUserFilter
object
2 properties
KalturaDynamicOrderBy
object
Kaltura Asset Order
2 properties
KalturaSeasonsReminderFilter
object
3 properties
KalturaSocialCommentFilter
object
5 properties
KalturaBaseOTTUser
object
Slim user data
4 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaDrmPlaybackPluginData
object
2 properties
KalturaValue
object
abstract A representation to return an array of values
2 properties
KalturaAnnouncementFilter
object
order announcements
1 property
KalturaSubscriptionFilter
object
4 properties
KalturaImageTypeFilter
object
3 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaDeviceReportFilter
object
Report filter
1 property
KalturaUserAssetRuleFilter
object
User asset rule filter
3 properties
KalturaBookmarkFilter
object
Filtering Assets requests
3 properties
KalturaIntegerValue
object
A string representation to return an array of ints
1 property
KalturaLoginResponse
object
2 properties
KalturaFavoriteFilter
object
Favorite request filter
4 properties
KalturaStringValue
object
A string representation to return an array of strings
1 property
KalturaSubscriptionSetFilter
object
4 properties
KalturaOTTUserType
object
User type
2 properties
KalturaSearchHistoryFilter
object
1 property
KalturaLoginSession
object
Login response
1 property
KalturaProductPriceFilter
object
6 properties
KalturaBooleanValue
object
A string representation to return an array of booleans
1 property
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property
KalturaAssetReminderFilter
object
1 property
KalturaPersonalFeedFilter
object
1 property
KalturaInboxMessageFilter
object
4 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaCurrencyFilter
object
Currency filter
2 properties
KalturaSeriesReminderFilter
object
3 properties
KalturaParentalRuleFilter
object
2 properties
KalturaTopicFilter
object
1 property
KalturaMediaFileFilter
object
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
KalturaMultilingualStringValue
object
Array of translated strings
2 properties
KalturaHouseholdDeviceFilter
object
3 properties
KalturaCustomDrmPlaybackPluginData
object
1 property
KalturaTransactionHistoryFilter
object
Transactions filter
4 properties
KalturaOTTUser
object
User
14 properties
KalturaHouseholdDeviceListResponse
object
1 property
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaTranslationToken
object
Container for translation
2 properties
OTTRequest
object
2 properties
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaImageFilter
object
5 properties
KalturaAssetFilter
object
2 properties
KalturaDevicePin
object
Device pin
1 property
KalturaSocialFriendActivityFilter
object
4 properties
KalturaLongValue
object
A string representation to return an array of longs
1 property
KalturaLanguageFilter
object
Language filter
2 properties
KalturaTagFilter
object
5 properties
KalturaAssetCommentFilter
object
3 properties
KalturaRelatedObjectFilter
object
abstract Define KalturaRelatedObjectFilter
1 property
KalturaConfigurationGroupDeviceFilter
object
Configuration group device filter
2 properties
KalturaPricePlanFilter
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
