Skip to main content

Update the SnapLock retention time of a file

Contributors
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 parameters "expiry_time" or "retention_period" can be used to set or extend the retention time of file. Both "expiry_time" and "retention_period" parameters expect the date in ISO 8601 format. Additionally, the "expiry_time" parameter can also be set to "infinite" or "unspecified" and the "retention_period" parameter can also be set to "infinite". The input parameters are mutually exclusive.

  • volume file retention set

Learn more

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

_links

_links

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.

file_path

string

Specifies the volume relative path of the file

is_expired

boolean

This indicates if the file is under active retention or if the file is past its expiry time.

retention_period

string

Duration of retention time file to be locked with, An "infinite" retention period indicates that the file will be retained forever.

seconds_until_expiry

integer

Specifies the number of seconds until the expiration time of the file.

svm

svm

SVM, applies only to SVM-scoped objects.

volume

volume
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "expiry_time": "2058-06-04 19:00:00 +0000",
  "file_path": "/dir1/file",
  "is_expired": 1,
  "retention_period": "P2M",
  "seconds_until_expiry": 168,
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response codes

Error code Description

262179

Unexpected argument "\"

262186

Field "expiry_time" cannot be used with field "retention_period"

6691623

User is not authorized

13763279

The resulting expiry time due to the specified retention period is earlier than the current expiry time

14090348

Invalid Expiry time

14090347

File path must be in the format "\/<dir>\/<file path>"
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

volume

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or PATCH method.

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.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

snaplock_file_retention

Name Type Description

_links

_links

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.

file_path

string

Specifies the volume relative path of the file

is_expired

boolean

This indicates if the file is under active retention or if the file is past its expiry time.

retention_period

string

Duration of retention time file to be locked with, An "infinite" retention period indicates that the file will be retained forever.

seconds_until_expiry

integer

Specifies the number of seconds until the expiration time of the file.

svm

svm

SVM, applies only to SVM-scoped objects.

volume

volume

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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