Skip to main content
REST API reference
A newer release of this product is available.

Delete an existing file or directory

PDFs

DELETE /storage/volumes/{volume.uuid}/files/{path}

Introduced In: 9.8

Deletes an existing file or directory. Query-based DELETE operations are not supported.

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

path

string

path

True

The relative path of a directory in the volume. The path field requires using "%2E" to represent ".", "%2E%2E" to represent ".." and "%2F" to represent "/" for the path provided. Refer to "relative reference resolution" section in Getting started with the ONTAP REST API for considerations when using "..".

recurse

boolean

query

False

Delete an entire directory. The behaviour of this call is equivalent to rm -rf.

  • Default value:

throttle_deletion

integer

query

False

The maximum number of directory delete operations per second. A valid throttle_deletion number is an integer from 10 to 100000.

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

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: 0

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

131102

Read-only file system.

131138

Directory not empty.

918235

A volume with UUID {volume.uuid} was not found.

6488081

The {field} field is not supported for DELETE operations.

6488110

A volume delete is not supported on this endpoint.

6684674

No such file or directory.

Also see the table of common errors in the Response body overview section of this documentation.

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

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.