How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaltura householdDevice API

The householdDevice API from Kaltura — 9 operation(s) for householddevice.

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

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 3.2.0, at version 3.6.287.20720.

Requests are made against 2 base URLs: https://tvpapi-us-preprod.ott.kaltura.com/api_v3, http://tvpapi-us-preprod.ott.kaltura.com/api_v3.

9 operations 9 paths 80 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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.add body → 200x-Errors
POST
/service/householddevice/action/addByPin
Registers a device to a household using pin code
householdDevice.addByPin body → 200x-Errors
POST
/service/householddevice/action/delete
Removes a device from household
householdDevice.delete body → 200x-Errors
POST
/service/householddevice/action/generatePin
Generates device pin to use when adding a device to household by pin
householdDevice.generatePin body → 200
POST
/service/householddevice/action/get
Returns device registration status to the supplied household
householdDevice.get body → 200x-Errors
POST
/service/householddevice/action/list
Returns the devices within the household
householdDevice.list body → 200x-Errors
POST
/service/householddevice/action/loginWithPin
User sign-in via a time-expired sign-in PIN.
householdDevice.loginWithPin body → 200x-Errors
POST
/service/householddevice/action/update
Update the name of the device by UDID
householdDevice.update body → 200x-Errors
POST
/service/householddevice/action/updateStatus
Update the name of the device by UDID
householdDevice.updateStatus body → 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), KalturaTagFilter (5 properties). Each schema is shown below with its type and property counts.

KalturaPersonalFeedFilter
object
1 property
KalturaSeriesRecordingFilter
object
Filtering recordings
1 property
KalturaSubscriptionSetFilter
object
4 properties
KalturaFollowTvSeriesFilter
object
1 property
KalturaAssetReminderFilter
object
1 property
KalturaOTTUser
object
User
14 properties
KalturaDoubleValue
object
A string representation to return an array of doubles
1 property
KalturaMultilingualStringValue
object
Array of translated strings
2 properties
OTTRequest
object
2 properties
KalturaHouseholdUserFilter
object
2 properties
KalturaValue
object
abstract A representation to return an array of values
2 properties
KalturaIntegerValue
object
A string representation to return an array of ints
1 property
KalturaAggregationCountFilter
object
Kaltura Aggregation CountFilter
1 property
KalturaCollectionFilter
object
Collection Filter
3 properties
KalturaPriceDetailsFilter
object
2 properties
KalturaImageFilter
object
5 properties
KalturaParentalRuleFilter
object
2 properties
KalturaCustomDrmPlaybackPluginData
object
1 property
KalturaHouseholdDevice
object
Device details
8 properties
KalturaAnnouncementFilter
object
order announcements
1 property
KalturaFavoriteFilter
object
Favorite request filter
4 properties
KalturaBaseOTTUser
object
Slim user data
4 properties
KalturaPersistedFilter
object
abstract
2 properties
KalturaMetaFilter
object
Meta filter
5 properties
KalturaSearchHistoryFilter
object
1 property
KalturaFilter
object
abstract
2 properties
KalturaDrmPlaybackPluginData
object
2 properties
KalturaDevicePin
object
Device pin
1 property
KalturaUserRoleFilter
object
User roles filter
3 properties
KalturaInboxMessageFilter
object
4 properties
KalturaLongValue
object
A string representation to return an array of longs
1 property
KalturaRecordingContextFilter
object
Filtering assets
2 properties
KalturaProductPriceFilter
object
6 properties
KalturaAssetHistoryFilter
object
5 properties
KalturaPricePlanFilter
object
2 properties
KalturaSocialFriendActivityFilter
object
4 properties
KalturaEntitlementFilter
object
Entitlements filter
4 properties
KalturaHouseholdDeviceListResponse
object
1 property
KalturaRelatedObjectFilter
object
abstract Define KalturaRelatedObjectFilter
1 property
KalturaTagFilter
object
5 properties
KalturaSeriesReminderFilter
object
3 properties
KalturaPaymentMethodProfileFilter
object
2 properties
KalturaConfigurationGroupTagFilter
object
Configuration group tag filter
2 properties
KalturaReportFilter
object
abstract Report filter
2 properties
KalturaAssetFilter
object
2 properties
KalturaRegionFilter
object
2 properties
KalturaConfigurationsFilter
object
Configuration filter
2 properties
KalturaListResponse
object
Base list wrapper
1 property
KalturaReminderFilter
object
abstract
1 property
KalturaStringValue
object
A string representation to return an array of strings
1 property
KalturaUserAssetRuleFilter
object
User asset rule filter
3 properties
KalturaCurrencyFilter
object
Currency filter
2 properties
KalturaTranslationToken
object
Container for translation
2 properties
KalturaOTTUserFilter
object
OTT User filter
4 properties
KalturaMediaFileFilter
object
3 properties
KalturaSubscriptionFilter
object
4 properties
KalturaDeviceReportFilter
object
Report filter
1 property
KalturaChannelsFilter
object
4 properties
KalturaBooleanValue
object
A string representation to return an array of booleans
1 property
KalturaTopicFilter
object
1 property
KalturaLoginSession
object
Login response
1 property
KalturaImageTypeFilter
object
3 properties
KalturaSocialActionFilter
object
4 properties
KalturaCountryFilter
object
Country filter
4 properties
KalturaConfigurationGroupDeviceFilter
object
Configuration group device filter
2 properties
KalturaEngagementFilter
object
3 properties
KalturaHouseholdDeviceFilter
object
3 properties
KalturaSeasonsReminderFilter
object
3 properties
KalturaRecordingFilter
object
Filtering recordings
3 properties
KalturaOTTUserType
object
User type
2 properties
KalturaLanguageFilter
object
Language filter
2 properties
KalturaPluginData
object
KalturaLoginResponse
object
2 properties
KalturaExportTaskFilter
object
Bulk export tasks filter
2 properties
KalturaTransactionHistoryFilter
object
Transactions filter
4 properties
KalturaAssetCommentFilter
object
3 properties
KalturaDynamicOrderBy
object
Kaltura Asset Order
2 properties
KalturaAssetStructFilter
object
Filtering Asset Structs
4 properties
KalturaSocialCommentFilter
object
5 properties
KalturaBookmarkFilter
object
Filtering Assets requests
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-householddevice-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
Where this information came from

This is an independent, third-party profile of Kaltura householdDevice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.