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 household API

The household API from Kaltura — 8 operation(s) for household.

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

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

This API exposes 8 operations across 8 paths, and defines 2 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.

8 operations 8 paths 2 schemas 8 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 household 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 8

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

household 8
POST
/service/household/action/add
Creates a household for the user
household.add 1 param → 200x-Errors
POST
/service/household/action/delete
Fully delete a household. Delete all of the household information, including users, devices, entitlements, payment methods and notification date.
household.delete 1 param → 200x-Errors
POST
/service/household/action/get
Returns the household model
household.get 1 param → 200x-Errors
POST
/service/household/action/purge
Purge a household. Delete all of the household information, including users, devices, entitlements, payment methods and notification date.
household.purge 1 param → 200x-Errors
POST
/service/household/action/resetFrequency
Reset a household’s time limitation for removing user or device
household.resetFrequency 1 param → 200
POST
/service/household/action/resume
Resumed a given household service to its previous service settings
household.resume 1 param → 200x-Errors
POST
/service/household/action/suspend
Suspend a given household service. Sets the household status to “suspended".The household service settings are maintained for later resume
household.suspend 1 param → 200x-Errors
POST
/service/household/action/update
Update the household name and description
household.update 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are KalturaHousehold (15 properties), OTTRequest (2 properties). Each schema is shown below with its type and property counts.

KalturaHousehold
object
Household details
15 properties
OTTRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaltura-household-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