Retention-related request headers

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The table below describes the retention-related request headers you can use with the S3 compatible API.

Header Methods Description
x-hcp-retention

PUT object

PUT object copy

POST object complete multipart upload

Specifies the retention value for the object being stored. This value can be a fixed date, an offset, a retention class, or a special value.
x-hcp-retentionhold

PUT object

PUT object copy

POST object complete multipart upload

Specifies whether the object is on hold. This value can be either true or false.
x-hcp-privileged

DELETE object

DELETE multiple objects

If you have privileged permission and the bucket allows it, this enables a privileged delete on an object that is under retention. The valid value for this header is a text string of up to 1,024 characters long, which can contain any valid UTF-8 characters, including white space.