Update the SnapLock retention time of a file
Suggest changes
PDFs
PATCH /storage/snaplock/file/{volume.uuid}/{path}
Introduced In: 9.7
Updates the SnapLock retention time of a file or extends the retention time of a WORM file. Input parameter "expiry_time" expects the date in ISO 8601 format, "infinite", or "unspecified".
Related ONTAP commands
-
volume file retention set
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
volume.uuid |
string |
path |
True |
Volume UUID |
path |
string |
path |
True |
Path of the file in the form "/<dirpath>/<filename>" </filename></dirpath> |
Request Body
| Name | Type | Description |
|---|---|---|
expiry_time |
string |
Expiry time of the file in date-time format, "infinite", "indefinite", or "unspecified". An "infinite" retention time indicates that the file will be retained forever. An "unspecified" retention time indicates that the file will be retained forever; however, the retention time of the file can be changed to an absolute value. An "indefinite" retention time indicates that the file is under Legal-Hold. |
Example request
{
"expiry_time": "2058-06-04T19:00:00Z"
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response codes
| Error code | Description |
|---|---|
14090347 |
File path must be in the format "/ |
14090348 |
Invalid Expiry time |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
svm
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
volume
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
snaplock_file_retention
| Name | Type | Description |
|---|---|---|
expiry_time |
string |
Expiry time of the file in date-time format, "infinite", "indefinite", or "unspecified". An "infinite" retention time indicates that the file will be retained forever. An "unspecified" retention time indicates that the file will be retained forever; however, the retention time of the file can be changed to an absolute value. An "indefinite" retention time indicates that the file is under Legal-Hold. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |