Retention policy
A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention policies and then later assign them to specific folders, metadata templates, or their entire enterprise. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console.
"12345"The unique identifier that represents a retention policy.
"retention_policy"retention_policy
Value is always retention_policy
falseDetermines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
Counts the retention policy assignments for each item type.
1The number of enterprise assignments this policy has. The maximum value is 1.
1The number of folder assignments this policy has.
1The number of metadata template assignments this policy has.
falseDetermines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
"2012-12-12T10:53:43-08:00"When the retention policy object was created.
A mini user object representing the user that created the retention policy.
A list of users notified when the retention policy duration is about to end.
"Policy to retain all reports for at least one month"The additional text description of the retention policy.
"permanently_delete"The disposition action of the retention policy.
This action can be permanently_delete, which
will cause the content retained by the policy
to be permanently deleted, or remove_retention,
which will lift the retention policy from the content,
allowing it to be deleted by users,
once the retention policy has expired.
Value is one of permanently_delete,remove_retention
"2012-12-12T10:53:43-08:00"When the retention policy object was last modified.
"Some Policy Name"The name given to the retention policy.
"finite"The type of the retention policy. A retention
policy type can either be finite, where a
specific amount of time to retain the content is known
upfront, or indefinite, where the amount of time
to retain the content is still unknown.
Value is one of finite,indefinite
"365"1The length of the retention policy. This value
specifies the duration in days that the retention
policy will be active for after being assigned to
content. If the policy has a policy_type of
indefinite, the retention_length will also be
indefinite.
"non-modifiable"Specifies the retention type:
-
modifiable: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. -
non-modifiable: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
Value is one of modifiable,non-modifiable
"active"The status of the retention policy. The status of
a policy will be active, unless explicitly retired by an
administrator, in which case the status will be retired.
Once a policy has been retired, it cannot become
active again.
Value is one of active,retired
Response Example
{
"id": "12345",
"type": "retention_policy",
"are_owners_notified": false,
"assignment_counts": {
"enterprise": 1,
"folder": 1,
"metadata_template": 1
},
"can_owner_extend_retention": false,
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"custom_notification_recipients": [
{
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
}
],
"description": "Policy to retain all reports for at least one month",
"disposition_action": "permanently_delete",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Some Policy Name",
"policy_type": "finite",
"retention_length": "365",
"retention_type": "non-modifiable",
"status": "active"
}