File Version Retention

A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. For more information about retention policies, please visit our help documentation

string / date-time
2012-12-12T10:53:43-08:00

When this file version retention object was created

string / date-time
2012-12-12T10:53:43-08:00

When the retention period expires on this file version retention

The file this file version retention was applied to

The file version this file version retention was applied to

string
11446498

The unique identifier for this object

string
file_version_retention

Value is always "file_version_retention"

The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.

Response Example

{
  "id": 11446498,
  "type": "file_version_retention",
  "file_version": {
    "id": 12345,
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "file": {
    "id": 12345,
    "etag": 1,
    "type": "file",
    "sequence_id": 3,
    "name": "Contract.pdf"
  },
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "winning_retention_policy": {
    "id": 12345,
    "type": "file_version",
    "policy_name": "Some Policy Name",
    "retention_length": 0,
    "disposition_action": "permanently_delete"
  }
}