Viewprivate

Retrieve a list of Account DRM defined for the current account or customer, and (optionally) server role or id.

This API call will return back “private” data (such as license key), and, as such, is using a different token (readall).

Only one of drm (hash) or streamtype is allowed, not both.

If no streamtype or drm is specified, it will return a list of explicitly set DRM records for this account.

If a streamtype is specified, it will try to figure out the DRM record for that streamtype for this account. This can be either explicit (it is set in the database already, added via API or the manager), or implicit, which is something not set, but based on other ones (such as having one no-drm entry will trigger others to be no-drm).

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • accountdrm-readall

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
drm Hash   Hash of the DRM record to view
streamtype String  

DRM Stream Type to view

This argument can only contain one of the following values:

  • progressive
  • hls
  • mpeg-dash
  • hds
  • smooth

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash Id for this Account DRM
streamtype String Stream Type to use
drmtype String DRM type used
provider String 3rd party DRM provider
licensekey String License key for this DRM type
licensekeyiv String License key IV for this DRM type
licenseserver String License server for this DRM type
specificdata String Specific Data (PSSH) for this DRM type

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_DRM_NOT_FOUND (520)
The requested record could not be found