Create a quota profile

Request

You can set up any number of quota profiles to which user accounts can be associated.

To create a quota profile, send a POST request to:

https://<host>:<port>/cdvr/v1/operator/quotaprofile

Headers

• Content-Type: application/json

Mandatory arguments

• name – the name of the quota profile to be created

• quota – the size of the quota in seconds

• status – ENABLED or DISABLED

Other arguments

• retentionPeriod – the retention period applied to the recordings made by accounts to which the profile applies. This is in ISO8601 format (for example, P60D for 60 days). autoDelete must be true for this to have any effect.

• autoDelete – enables/disables automatic deletion (true or false)

• autoDeleteOptions – options for automatic deletion (autoDelete must be true for these to have any effect):

  • isBasedOnAge – enables/disables automatic deletion based on recording age (true or false)

  • isBasedOnNumberOfEpisodes – enables/disables automatic deletion of the oldest episodes in series (true or false)

Note that if both isBasedOnAge and isBasedOnNumberOfEpisodes are set to true, User Recordings will first try to delete older series episode recordings, and will only then try to delete older (non-series) recordings if there is still insufficient quota available to enable the recording request that prompted the deletion.

Example

A POST request with this payload creates a quota profile called LARGE with a size of 100 hours and enables it:

{
  "name": "LARGE",
  "quota": "360000",
  "status": "ENABLED"
}

Response

A successful request returns an HTTP 201 status.
A bad request returns an HTTP 400 status.

See also

For full details of this API, see the NPVR User Recordings API documentation v1.