Endpoint to use case mappings

POST /ias/v3/token/actions/signOnByUserNamePassword

Retrieve device token using username, password, and device details.

​

Also mentioned in ​

POST /ias/v3/token/actions/signOnByCasn

Retrieve device token using the device's casn identifier.

​

POST /ias/v3/token/actions/signOnBySmartCardId

Retrieve device token using the device's smartcard identifier.

​

POST /ias/v3/token/actions/signOnByTVKeyActivation

Retrieve signon token using TVKey activation and optional device information. In order for the API to work, the device must be pre-provisioned.

​

POST /v3/token/actions/refresh

Refresh signon token

POST /v3/token/actions/signOut

Sign out

POST /v3/das-token

Validates user and password credentials from the request body, get deviceId from DAS-Server, creating a new device and returns an SSP Token with optional device information

POST /v3/token/actions/signOnBySignOnActivationToken

SignOn to OPF using a SignOnActivation Token created by DSRA

​

Part of ​

POST /v3/selfservicetoken

Self-service token

POST /v2/selfservicetoken

Self Service Token deprecated due to sensitive information in parameters

Not actually deprecated, but there is a v3 version.

POST /v2/token

Get device token (four variants)

​

POST /v2/token

Sign out

GET /servicediscovery

Discover auth services

​

POST /signOnWithSessionToken

Retrieve SignOn token using provided sessionToken

POST /getSessionToken

Obtains a sessionToken for subsequent use in calls to /signOnWithSessionToken.

POST /signOn

Retrieve SignOn token using provided credentials.

​

POST /subsequentSignOn

Subsequent SignOn to be used when the initial SignOn endpoint returns a 300 to indicate there are multiple accounts associated with the user.

​

POST /refresh

Refreshes a SignOn token

​

POST /signOut

Signs Out from an account

​

POST /register/{type}

Register using provided credentials.

POST /subsequentRegister

Subsequent Registration to be used when the initial Register endpoint returns a 300 to indicate there are multiple accounts associated with the user.

GET /v1/user/deviceRegistrationCode

Get a Device Registration Code and DSRA Token.

Requesting a device registration code (registering device)

Under Signing on with a companion app

PUT /v1/user/signOnActivationToken

Obtain a SignOn Activation Token.

Requesting a sign-on/activation token (registering device)

PUT /v1/user/deviceRegistrationCode/actions/approve

Approve a Device Registration Code.

Approving a sign-on request (companion app)

POST /v3/token/actions/changeUserProfile

Change (switch) user profile

​

POST /v2/cdn_token

Get content token with CDN token

POST /v2/content_token

Get content token

​

Also in “Fetching the content token” in ​

POST /v2/isPPVAuthorised

Get content token for PPV event

POST /v2/isD2GoAuthorised

Get content token for Download2Go

D2Go is documented here:​

But this endpoint is not mentioned.

GET /token/v1/validate

Validate and decode an OPF3 JWT token.

GET /v2/actions/is-in-house

Test for in-house by IP address

POST /v2/das-token/user/{userId}/password/{password}

Validate credentials and get device ID from DAS

GET /v2/das-token/user/authorised

Get device ID using devAuthToken and DAS SDK data

GET /v1/localeInfo

Returns the locale information for the clients IP Address

GET /v1/user/capabilities

Get all capability type Entitlements

Get the capability entitlements for the account

GET /v1/user/entitlements/{uid}

Get a user Entitlement

Get entitlements for a particular content

The use cases uses the wrong endpoint (/v1/user/action/authorisation/content/{uid}, which is an operator endpoint).

GET /v1/user/entitlements

Get a user Entitlements

Get all entitlements for an account

GET /v1/user/device/entitlements

Get a list of User Entitlements for the requesting device.

POST /v1/user/room

Create a room.

Creating a guest entitlements room and inviting guests

Under Enabling guest entitlements

PUT /v1/user/room/{roomId}

Join a room.

Using a room ID to join a guest entitlements room

GET /v1/user/room/{roomId}

Get the status and membership of a room.

Getting guest entitlements room status

POST /v1/user/product/actions/purchase

Purchase a product

Making a purchase

GET /v1/user/accounts

Get account by ID (that is, AccountUID in the token header)

Get account data

PUT /v1/user/accounts/actions/changePassword

Change password

This is only applicable where OPF is being used for sign-on (that is, not SSO).

GET /v1/user/accounts/pins

Get PINs for the account (that is, whether a PIN is set for the account for each PIN type, not the actual values of the PINs)

These are all under the General PIN management section.

POST /v1/user/accounts/actions/validatePin

Validate PIN

Verifying user-supplied PINs

PUT /v1/user/accounts/actions/changePin

Change PIN

Resetting a PIN

POST /v1/user/accounts/actions/pin

Create PIN

Setting a PIN

GET /v1/user/accounts/pins/status

Get status of all PINs

Getting the status of all PINs for the account

GET /v1/user/devices/amiapproved

Check if device is approved.

Check device approval status

All in Device limits section

POST /v1/user/devices/amendapprovals

Approve/unapprove a device.

Add/remove devices to/from the approved devices list

GET /v1/user/devices/canIApproveADevice

Get next available approval time.

Check next available approval time and number of approved devices

GET /v1/user/accounts/parentalControl/ratingsThresholds

Get parental rating thresholds for an account.

Getting the rating thresholds for the account

All in the Parental controls section

PUT /v1/user/accounts/parentalControl/actions/updateRatingsThresholds

Update parental rating thresholds for an account.

Setting/updating the rating threshold

POST /v1/user/accounts/parentalControl/actions/deleteRatingsThresholds

Delete parental rating thresholds for an account.

Deleting rating thresholds

POST /activitygateway/v1/useractivity/rating

Log a new rating request (This is just a specialization of the raw useractivity api)

POST /activitygateway/v1/useractivity/{activityName}

Log a new activity

PUT /activitygateway/v1/clientdata/account/{account}/bookmarks/{contentId}

Creates or updates an existing bookmark for account

DELETE /activitygateway/v1/clientdata/account/{account}/bookmarks/{contentId}

Deletes an existing bookmark for a given account

DELETE /activitygateway/v1/clientdata/account/{account}/bookmarks

Deletes all existing bookmarks for a given account. Only one query param may be passed.

DELETE /activitygateway/v1/clientdata/account/{account}/bookmarks/action/deleteByTag/{tagId}

Deletes an existing bookmark for a given account based on tagId

PUT /activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

Creates or updates an existing bookmark for user

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

Deletes an existing bookmark for a given user

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/bookmarks/action/deleteByTag/{tagId}

Deletes an existing bookmark for a given user based on tagId

POST /activitygateway/v1/clientdata/account/{account}/favouriteslists

Creates a new favouriteslist for account

PUT /activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}

Updates an existing account's favouriteslist

DELETE /activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}

Deletes an existing account's favouriteslist and all entries

PUT /activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

Adds a favourite to an account's favouriteslist

DELETE /activitygateway/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

Removes a favourite from an account's favouriteslist

POST /activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists

Creates a new favouriteslist for a user

PUT /activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

Updates an existing user's favouriteslist

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

Deletes an existing user's favouriteslist and all entries

PUT /activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

Adds a favourite to a favouriteslist

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

Removes a favourite from a favouriteslist

POST /activitygateway/v1/clientdata/account/{account}/history

Creates History for account

DELETE /activitygateway/v1/clientdata/account/{account}/history/{id}

Deletes an existing history entry

POST /activitygateway/v1/clientdata/account/{account}/user/{userId}/history

Creates history for user

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/history/{id}

Deletes an existing history entry

PUT /activitygateway/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

Adds a playlist entry to an account's playlist

DELETE /activitygateway/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

Removes a playlist entry from an account's playlist

PUT /activitygateway/v1/clientdata/account/{account}/playlists/{id}

Updates an existing account's playlist

DELETE /activitygateway/v1/clientdata/account/{account}/playlists/{id}

Deletes an existing account's playlist and all entries

POST /activitygateway/v1/clientdata/account/{account}/playlists

Creates a new playlists for account

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}/content/{contentId}

Removes a playlistEntry from a playlist

PUT /activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

Updates an existing user's playlist

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

Deletes an existing user's playlist and all entries

POST /activitygateway/v1/clientdata/account/{account}/user/{userId}/playlists

Creates a new playlists for a user

POST /activitygateway/v1/clientdata/account/{account}/reminders

Creates a new reminder for an account

DELETE /activitygateway/v1/clientdata/account/{account}/reminders/{id}

Deletes an existing reminder for a given user

POST /activitygateway/v1/clientdata/account/{account}/user/{userId}/reminders

Creates a new reminder

DELETE /activitygateway/v1/clientdata/account/{account}/user/{userId}/reminders/{id}

Deletes an existing reminder for a given user

GET /useractivityvault/v1/notifications/viewcount

Get any view counts that have been incremented since the provided startDate

GET /useractivityvault/v1/notifications/ratings

Obtain the notifications for any modifications made to average ratings

GET /useractivityvault/v1/ratings/account/{account}

Get all ratings logged by the given account results include ratings by all users that belong to that account

​

GET /useractivityvault/v1/ratings/content/{contentId}/account/{account}/user/{userId}

Get a specific rating made by a user-account combination

GET /useractivityvault/v1/ratings/content/{contentId}/account/{account}

Obtain a list of ratings made by a specific account for the given content returns a number of ratings if there's more than one user per account

Retrieve a VOD content rating for an account

GET /useractivityvault/v1/ratings/content/{contentId}

Get ratings by all users and accounts made against the specified content

GET /useractivityvault/v1/ratings/account/{account}/user/{userId}

Get all ratings logged by the given user for a specific account

GET /useractivityvault/v1/ratings/content/{contentId}/average

Obtain the average rating for a given piece of content

​Retrieve the average rating for a BTV content

POST /useractivityvault/v1/useractivity/rating

Log a new rating request (This is just a specialization of the raw useractivity api)

GET /useractivityvault/v1/useractivity/{activityName}/account/{account}/user/{userId}

Query for a list of activities logged by a specific account and user

Reporting activity and event metrics to UAV

GET /useractivityvault/v1/useractivity/{activityName}/account/{account}

Query for a list of activities logged by a specific account

POST /useractivityvault/v1/useractivity/{activityName}

Log a new activity

​

GET /useractivityvault/v1/clientdata/account/{account}/bookmarks/{contentId}

Gets a bookmark for a given account and content

​Get a single bookmark for a content item

PUT /useractivityvault/v1/clientdata/account/{account}/bookmarks/{contentId}

Creates or updates an existing bookmark for account

​Add a bookmark

​Update a bookmark

DELETE /useractivityvault/v1/clientdata/account/{account}/bookmarks/{contentId}

Deletes an existing bookmark for a given account

​

GET /useractivityvault/v1/clientdata/account/{account}/bookmarks

Gets all bookmarks for a given account

​Get all bookmarks for an account

DELETE /useractivityvault/v1/clientdata/account/{account}/bookmarks

Deletes all existing bookmarks for a given account.

​Delete all bookmarks for an account

Delete all bookmarks for an account for a series/season

​Delete all bookmarks created before or after a certain date for an account

​

DELETE /useractivityvault/v1/clientdata/account/{account}/bookmarks/action/deleteByTag/{tagId}

Deletes an existing bookmark for a given account based on tagId

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

Gets a bookmark for a given user and content

Delete a bookmark

PUT /useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

Creates or updates an existing bookmark for user

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks/{contentId}

Deletes an existing bookmark for a given user

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks

Gets all bookmarks for a given user

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/bookmarks/action/deleteByTag/{tagId}

Deletes an existing bookmark for a given account based on tagId

GET /useractivityvault/v1/clientdata/account/{account}/favouriteslists

Gets all favouriteslists for a given account

​Get favourites lists for an account

POST /useractivityvault/v1/clientdata/account/{account}/favouriteslists

Creates a new favouriteslist for account

​Add a favourites list

GET /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}

Gets all favourites from a list for a given account

​Get all favourites in a favourites list

PUT /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}

Updates an existing account's favouriteslist

​Update a favourites list

DELETE /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}

Deletes an existing account's favouriteslist and all entries

​Delete a favourites list

GET /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

Return a group of favourites based on contentId

​Get a specific favourite

PUT /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

Adds a favourite to an account's favouriteslist

​Add a favourite to a favourites list

DELETE /useractivityvault/v1/clientdata/account/{account}/favouriteslists/{id}/content/{contentId}

Removes a favourite from an account's favouriteslist

​Delete a favourite from a favourites list

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists

Gets all favouriteslists for a given user

POST /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists

Creates a new favouriteslist for a user

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

Gets all favourites from list for a given user

PUT /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

Updates an existing user's favouriteslist

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}

Deletes an existing user's favouriteslist and all entries

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

Return a group of favourites based on contentId

PUT /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

Adds a favourite to a favouriteslist

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/favouriteslists/{id}/content/{contentId}

Removes a favourite from a favouriteslist

GET /useractivityvault/v1/clientdata/account/{account}/history

Gets all Histories for a given account

POST /useractivityvault/v1/clientdata/account/{account}/history

Creates History for account

DELETE /useractivityvault/v1/clientdata/account/{account}/history/{id}

Deletes an existing history entry

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/history

Gets all Histories for a given account

POST /useractivityvault/v1/clientdata/account/{account}/user/{userId}/history

Creates history for user

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/history/{id}

Deletes an existing history entry

PUT /useractivityvault/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

Adds a playlist entry to an account's playlist

DELETE /useractivityvault/v1/clientdata/account/{account}/playlists/{id}/content/{contentId}

Removes a playlist entry from an account's playlist

GET /useractivityvault/v1/clientdata/account/{account}/playlists/{id}

Gets all playlist from a list for a given account

PUT /useractivityvault/v1/clientdata/account/{account}/playlists/{id}

Updates an existing account's playlist

DELETE /useractivityvault/v1/clientdata/account/{account}/playlists/{id}

Deletes an existing account's playlist and all entries

GET /useractivityvault/v1/clientdata/account/{account}/playlists

Gets all playlists for a given account

POST /useractivityvault/v1/clientdata/account/{account}/playlists

Creates a new playlists for account

PUT /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists/{id}/content/{contentId}

Adds a playlist entry to a playlist

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists/{id}/content/{contentId}

Removes a playlistEntry from a playlist

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

Gets all playlist entry from list for a given user

PUT /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

Updates an existing user's playlist

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists/{id}

Deletes an existing user's playlist and all entries

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists

Gets all playlists for a given user

POST /useractivityvault/v1/clientdata/account/{account}/user/{userId}/playlists

Creates a new playlists for a user

GET /useractivityvault/v1/clientdata/account/{account}/reminders

Gets reminders for a given user

POST /useractivityvault/v1/clientdata/account/{account}/reminders

Creates a new reminder for an account

DELETE /useractivityvault/v1/clientdata/account/{account}/reminders/{id}

Deletes an existing reminder for a given user

GET /useractivityvault/v1/clientdata/account/{account}/user/{userId}/reminders

Gets reminders for a given user

POST /useractivityvault/v1/clientdata/account/{account}/user/{userId}/reminders

Creates a new reminder

DELETE /useractivityvault/v1/clientdata/account/{account}/user/{userId}/reminders/{id}

Deletes an existing reminder for a given user

GET /v1/playout/content/token

Request for CDN token

Getting playout URL and tokens

GET /v1/playout/ppv/content/token

Request for CDN token for PPV

GET /v1/playout/channel/{channelId}

Request for customisation of URL based on channel

GET /v1/user/userprofiles

Get all of the User Profiles for an Account

Getting all the user profiles for an account

POST /v1/user/userprofiles

Creates a User Profile for an account

Creating a user profile

GET /v1/user/userprofiles/{profileid}

Get User Profile

PUT /v1/user/userprofiles/{profileid}

Update a User Profile on an account

Modifying an existing profile

DELETE /v1/user/userprofiles/{profileid}

Delete a User Profile from an Account

Deleting an existing user profile

POST /opendevice/{deviceId}/queue

Registers an open device for platform/system notifications.

Registering a device

GET /client/castCrewPersonas

Returns one or more cast/persona entries

GET /client/users/{accountId}/{userId}

Returns the details of the user for the given account and user Id

PUT /client/users/{accountId}/{userId}

Updates the details of the user for the given account and user Id

DELETE /client/users/{accountId}/{userId}

Removes the entry of the user for the given account and user Id

GET /client/users

Returns one or more users

GET /contentdelivery/v1/templateviews

Get a list of unpopulated templateviews.

Retrieve all templates with child template IDs

GET /contentdelivery/v1/templateviews/hierarchy

Get a list of unpopulated templateviews (no rails), allowing the client to "browse" and choose one.

Retrieve all templates with all their child templates

GET /contentdelivery/v1/templateviews/hierarchy/{id|name

Get an unpopulated templateview by id (no rails).

GET /contentdelivery/v1/templateSkeleton/{id|name}

Get a tempate skeleton which list rail ids

GET /contentdelivery/v1/templateviews/{id|name}

Get the contents of all the rails within a template

Retrieve all or part of the rails and related content for a template

GET /contentdelivery/v1/templateviews/{id|name}/rails/{railId}

Get the contents of a rail

Retrieve a specific rail and its contents

GET /contentdelivery/v1/templatesummary/{templateid|templatename}

Get the IDs and properties of all the rails for the requested template, without any related data.

Retrieve the rail structure for a template

Missing from latest Content Delivery OAS

GET /contentdelivery/v2/templateviews/{id|name}

Get the contents of all the rails within a template

Searching using search rails

This appends ?q="<query>" to the URL.

GET /contentdelivery/v2/templateviews/{id|name}/rails/{railId}

Get the contents of a rail

GET /epg

Get programmes for a given time period across all channels, or for a specific channel

Retrieving events for an EPG window – pre-defined queries

GET /epg/now

Get current programmes available across all channels

Retrieving previous/now/next programmes – pre-defined queries

GET /catchup

Get catchup content

Retrieving catch-up content – predefined queries

GET /catchup/{event-id}

Get catchup content for a specific event

GET /epg/{id}/mediacard

Get mediacard for live programme

GET /vod/{id}/mediacard

Get mediacard for VOD content

GET /recordings/{id}/mediacard

Get mediacard for recording

GET /series/{id}/mediacard

Get mediacard for series

GET /subscribed/products

Get products to which the account (known from the authentication details) can get their products

Retrieving products for an authenticated account – predefined query

POST /v2/bookmarks/account/{accountId}/action/{action}

Add entry to an accounts bookmark list.

GET /v2/contexts

Get contexts.

Get contexts

Under Direct Integration with Ncanto

POST /v2/ratings/account/{accountId}

Rate content

Rate a VOD content for an account

Rate a BTV content for an account

POST /v2/recommendations/account/{accountId}

Get recommendations.

Get recommendations

Under Direct Integration with Ncanto

POST /v2/useractivity/{userActivity}/account/{accountId}

Record user activity

Report user activity

Under Direct Integration with Ncanto

GET /v1/image/imageid/{imageId}

Retrieve the image that matches the provided imageId

GET /v1/image/{contentType}/{id}/{imageType}

Retrieve an image that best matches the supplied criteria

Using ImageService to get images

GET /v1/profile

Returns profile records.

Getting all the available user profile icons

GET /metadata/delivery/GLOBAL/vod/nodes

Browse Video on Demand (VoD) Catalogues

Retrieve catalogue node information

GET /metadata/delivery/v2/GLOBAL/vod/editorials

Browse Video on Demand (VoD) Assets

Retrieve content information

GET /metadata/delivery/GLOBAL/vod/series

Browse Video on Demand (VoD) Series

Retrieving VOD series information

GET /metadata/delivery/GLOBAL/vod/products

Video On Demand (VoD) Products

Retrieve content information

GET /metadata/delivery/GLOBAL/btv/services

Browse Broadcast TV (BTV) Channels

Retrieving channel lists

Using DVB triplet information to get channel metadata

GET /metadata/delivery/GLOBAL/btv/programmes

Browse Broadcast TV (BTV) Programmes - EPG

Retrieving series and season information

GET /metadata/delivery/GLOBAL/btv/blackout_programmes

List programmes a client is banned from viewing

GET /metadata/delivery/GLOBAL/btv/series

Browse Broadcast TV (BTV) Series

Retrieving series and season information

GET /metadata/delivery/GLOBAL/btv/products

Browse Broadcast TV (BTV) Products

Retrieving related product information

GET /metadata/solr/GLOBAL/search

Search for any kind of metadata entity

Direct Content Search (via MDS & SOLR)

Keyword suggestion

Search

GET /metadata/delivery/changes

Gets changes to entities since a certain timestamp

Respond to metadata change notifications

Under Metadata change alerts

POST /v1/recommendations

Get recommendations for provided input

Recommendations Façade - Generic

POST /v1/useractivity

Record user activity related to a piece of content

Recommendations Façade - Generic

GET /search/v1/engines

Make a request for list of search engines

Mentioned in Search Facade

GET /search/v1/search

Make a search request

Search Facade

GET /search/v1/suggest

Get typeahead suggestions based on partial search inputs

We do have a page for Keyword suggestion, but it uses Solr, not Search Facade.

GET /v1/aggregatedrecordings

Get aggregated recordings for the current account

GET /v1/account/quotausage

Return an account's cloud DVR quota usage

View current state of quota

GET v1/account/quotausage/series/{seriesId}

Return a user's quotaUsage based on seriesId in seconds

View quota usage for a series

GET /v1/recordings

Get recordings for the given account with various filtering and sorting options

There is a use case that uses GET /v2/recordings.

POST /v1/recordings

Request for a new recording to be scheduled

Create an event recording request

DELETE /v1/recordings/{id}

Cancel / delete a recording

Delete an event recording request

GET /v1/recordings/series/{seriesId}

Get recordings of episodes of the given series for the given account with various filtering and sorting options

There is a use case that uses GET /v2/seriesrecordings.

POST /v1/recordings/{id}

Cancel / delete a recording

PATCH /v1/recordings/{id}

Update / patch a recording with isProtected tag.

POST /v1/recordings/deleteRecordings

Cancel / delete a recording

POST /v1/seriesrecordings/repair/{id}

Request for a series recording to be repaired

GET /v1/seriesrecordings

Get series recordings for the current account

POST /v1/seriesrecordings

Request for a new series recording to be created

Create a series recording request

POST /v1/seriesrecordings/{id}

Remove a series recording

DELETE /v1/seriesrecordings/{id}

Remove a series recording

Delete a series recording request and/or recording

PATCH /v1/seriesrecordings/{id}

Update a single Series Recording

POST /v1/seriesrecordings/series/{seriesId}

Remove a series recording

GET /v1/seriesrecordings/status/series/{seriesId}

Get status of series recordings for the current account

GET v1/seriesrecordings/status

Get status of series recordings for the queried account

Retrieve series recording statuses

PUT /v1/seriesrecordings/recordingOptions/{id}

Update a Single Series Recording, Recording Options

GET /v2/recordings

Get recordings for the given account with various filtering and sorting options

Retrieve event recordings and requests

GET /v2/recordings/series/{seriesId}

Get recordings of episodes of the given series for the given account with various filtering and sorting options

GET /v2/seriesrecordings

Get series recordings for the current account

Retrieve series recordings and requests