Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

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

The unique identifier for this file version retention.

Example:

"11446498"

​
type
enum<string>

The value will always be file_version_retention.

Available options:
file_version_retention
Example:

"file_version_retention"

​
file_version
File version (Mini) · object

The file version this file version retention was applied to.

​
file
File (Mini) · object

The file this file version retention was applied to.

​
applied_at
string<date-time>

When this file version retention object was created.

Example:

"2012-12-12T10:53:43-08:00"

​
disposition_at
string<date-time>

When the retention expires on this file version retention.

Example:

"2012-12-12T10:53:43-08:00"

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