Skip to main content

Retrieve SnapLock retention details of a file

Contributors
PDFs

GET /storage/snaplock/file/{volume.uuid}/{path}

Introduced In: 9.7

Retrieves the SnapLock retention details of the specified file. An indefinite expiry time indicates the file is under a Legal-Hold.

  • volume file retention show

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>

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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 response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "expiry_time": "2058-06-04 15:00:00 -0400",
  "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"
  }
}

Error

Status: Default

ONTAP Error Response codes

Error code
 Description

---------

----------

262179

Unexpected argument "" //end row //start row

//end row //start row

917864 //end row //start row

Operation not supported //end row //start row

//end row //start row

6691623 //end row //start row

User is not authorized //end row //start row

//end row //start row

13762592 //end row //start row

Operation not supported on non-SnapLock volume //end row //start row

//end row //start row

14090347 //end row //start row

File path must be in the format "/

/" //end row //start row

//end row //start row

917804 //end row //start row

Path should be given in the format "/vol//". //end row

=== //end table

[cols=3*,options=header]

|Name |Type |Description

|error |returned_error a|

.Example error [%collapsible%closed] ==== [source,json,subs=+macros] { "error": { "arguments": [ { "code": "string", "message": "string" } ], "code": "4", "message": "entry doesn't exist", "target": "uuid" } } ====

== Definitions

[.api-def-first-level] .See Definitions [%collapsible%closed] ==== [#href] [.api-collapsible-fifth-title] href

[cols=3*,options=header]

|Name |Type |Description

|href |string a|

[#_links] [.api-collapsible-fifth-title] _links

[cols=3*,options=header]

|Name |Type |Description

|self |href a|

[#svm] [.api-collapsible-fifth-title] svm

SVM, applies only to SVM-scoped objects.

[cols=3*,options=header]

|Name |Type |Description

|_links |_links a|

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

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

[#volume] [.api-collapsible-fifth-title] volume

[cols=3*,options=header]

|Name |Type |Description

|_links |_links a|

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

|uuid |string a|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

[#error_arguments] [.api-collapsible-fifth-title] error_arguments

[cols=3*,options=header]

|Name |Type |Description

|code |string a|Argument code

|message |string a|Message argument

[#returned_error] [.api-collapsible-fifth-title] returned_error

[cols=3*,options=header]

|Name |Type |Description

|arguments |array[error_arguments] a|Message arguments

|code |string a|Error code

|message |string a|Error message

|target |string a|The target parameter that caused the error.

====