Skip to main content
REST API reference

Delete a LUN

PDFs

DELETE /storage/luns/{uuid}

Introduced In: 9.6

Deletes a LUN.

  • lun copy cancel

  • lun delete

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the LUN to retrieve.

allow_delete_while_mapped

boolean

query

False

Allows deletion of a mapped LUN.

A mapped LUN might be in use. Deleting a mapped LUN also deletes the LUN map and makes the data no longer available. This might cause a disruption in the availability of data.

This parameter should be used with caution.

  • 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

1254197

The LUN is mapped and cannot be deleted without specifying the allow_delete_while_mapped query parameter.

5374705

Deleting the LUN is not allowed because it is part of an application.

5374865

The LUN's aggregate is offline. The aggregate must be online to modify or remove the LUN.

5374866

The LUN's volume is offline. The volume must be online to modify or remove the LUN.

5374875

The specified LUN was not found.

5374876

The specified LUN was not found.

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.