Manage Applications

    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 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.

    string / date-time
    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

    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 time period has passed.

    Value is one of "permanently_delete", "remove_retention"

    string
    11446498

    The unique identifier for this object

    string / date-time
    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"

    string / int32
    0

    The length of the retention policy. This length 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.

    string
    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"

    string
    retention_policy

    Value is always "retention_policy"

    Response Example

    {
      "id": 11446498,
      "type": "retention_policy",
      "policy_name": "Some Policy Name",
      "policy_type": "finite",
      "retention_length": 0,
      "disposition_action": "permanently_delete",
      "status": "active",
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00"
    }