Update a quota profile
Request
To update a quota profile, send a PUT request to:
https://<host>:<port>/cdvr/v1/operator/quotaprofile/{quotaprofilename}
Headers
Content-Type: application/json
Mandatory arguments
quotaprofilename
– the name of the quota profile to be updated
Other arguments
name
– the new name of the quota profilequota
– the new size of the quota in secondsstatus
–ENABLED
orDISABLED
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 betrue
for this to have any effect.autoDelete
– enables/disables automatic deletion (true
orfalse
)autoDeleteOptions
– options for automatic deletion (autoDelete
must betrue
for these to have any effect):isBasedOnAge
– enables/disables automatic deletion based on recording age (true
orfalse
). Default:false
isBasedOnNumberOfEpisodes
– enables/disables automatic deletion of the oldest episodes in series (true
orfalse
). Default:false
Note that if both isBasedOnAge
and isBasedOnNumberOfEpisodes
are set to true
(and if autoDelete
is 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.
If both isBasedOnAge
and isBasedOnNumberOfEpisodes
are set to false
(and if autoDelete
is set to true
), User Recordings will try to delete the oldest recording, regardless of whether it belongs to a series or not.
If you rename a quota profile, any accounts that are associated with it will be unable to request any new recordings.
Example
A PUT request with this payload updates the specified quota profile so that it is disabled:
{
"status": "DISABLED"
}
Response
A successful request returns an HTTP 204 status.
A bad request returns an HTTP 400 status.
See also
For full details of this API, see the User Recordings API documentation.