Skip to main content
REST API reference

Delete a software package from the cluster

PDFs

DELETE /cluster/software/packages/{version}

Introduced In: 9.6

Deletes a software package from the cluster. The delete operation fails if the package is currently installed.

  • cluster image package delete

Learn more

Parameters

Name Type In Required Description

version

string

path

True

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

10551315

The repository does not contain any packages.

10551322

An internal error occurred while retrieving the package cleanup status.

10551323

An internal error occurred while removing the package information on a node.

10551324

An internal error occurred while removing the package information on multiple nodes.

10551325

The required package could not be found in the repository.

10551326

An error occurred while deleting older package cleanup tasks.

10551346

A validation is in progress, retry command after it is completed.

10551367

The repository is busy, retry the operation later.

10551388

The package delete operation timed out.

10551892

Package delete failed due to an unhealthy node. Restore the node to a healthy state, then retry the operation.

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

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.