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

Delete a volume Snapshot copy

Contributors
PDFs

DELETE /storage/volumes/{volume.uuid}/snapshots/{uuid}

Introduced In: 9.6

Deletes a Volume Snapshot copy.

  • snapshot delete

Learn more

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

uuid

string

path

True

Snapshot copy UUID

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 Code

Error Code Description

2

An invalid value was entered for one of the fields.

524481

Snapshot copy was not deleted because the associated volume is locked or fenced.

1638521

Snapshot copies can only be deleted on read/write (RW) volumes.

1638538

Cannot determine the status of the Snapshot copy delete operation for the specified volume.

1638543

Failed to delete Snapshot copy because it has an owner.

1638555

The specified Snapshot copy has not expired or is locked.

1638600

The Snapshot copy does not exist.
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
Name Type Description

_links

_links

uuid

string

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

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.