Skip to main content
API version 2024.0 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 in your application management console. Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.
​
id
string
example: 11446498The unique identifier for this file version retention.
​
type
string
example: file_version_retentionThe value will always be file_version_retention.Value is always file_version_retention
​
applied_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When this file version retention object was created.
​
disposition_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the retention expires on this file version retention.
​
file
File (Mini)object
The file this file version retention was applied to.
​
file_version
File version (Mini)object
The file version this file version retention was applied to.
​
winning_retention_policy
Retention policy (Mini)object
The winning retention policy applied to this file version retention. A file version can have multiple retention policies applied.
{
  "id": "11446498",
  "type": "file_version_retention",
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "file": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "name": "Contract.pdf",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
  },
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "winning_retention_policy": {
    "id": "12345",
    "type": "retention_policy",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": "365"
  }
}