Skip to main content

Delete unexpired WORM files of a SnapLock enterprise volume

Contributors
PDFs

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

Introduced In: 9.7

Deletes unexpired WORM files of a SnapLock Enterprise volume. This is a privileged-delete operation. The only built-in role that has access to the command is vsadmin-snaplock.

  • volume file privileged-delete

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>

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response codes

Error code
 Description

---------

----------

262179

Unexpected argument "" //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

13763162 //end row //start row

SnapLock audit log volume is not configured for the SVM //end row //start row

//end row //start row

13763280 //end row //start row

Only a user with the security login role "vsadmin-snaplock" is allowed to perform this operation //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|

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

[cols=3*,options=header]

|Name |Type |Description

|_links |_links a|

|uuid |string a|The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

[#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.

====