Skip to main content
REST API reference

Update the anti-ransomware package on the cluster

PDFs

PATCH /security/anti-ransomware

Introduced In: 9.16

Updates the anti-ransomware package on the cluster.

Required properties

  • uri - URI of the anti-ransomware package

  • security anti-ransomware update-package-from-uri

Parameters

Name Type In Required Description

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

Request Body

Name Type Description

nodes

array[anti_ransomware_node]

uri

string

URI of the anti-ransomware package through a server
Example request 
{
  "nodes": [
    {
      "name": "node1",
      "version": "1.0"
    }
  ],
  "uri": "http://server/package"
}

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

203161684

Autonomous Ransomware Protection (ARP) package file must be either a .tar or .tgz file.

203161685

Autonomous Ransomware Protection (ARP) package file download failed.

203161686

Autonomous Ransomware Protection (ARP) package file unzip failed.

203161687

Autonomous Ransomware Protection (ARP) package file untar failed.

203161688

Autonomous Ransomware Protection (ARP) package archive invalid. No ARP version file found.

203161689

Internal error. Filesystem error while installing Autonomous Ransomware Protection (ARP) package file.

203161690

Autonomous Ransomware Protection (ARP) package update requires an effective cluster version of 9.16.1 or later.

203161691

Autonomous Ransomware Protection (ARP) package file is invalid. The checksum verification of the ARP configuration files failed.

203161692

Autonomous Ransomware Protection (ARP) package update failed because one or more nodes are not healthy.

203161694

Failed to update the Autonomous Ransomware Protection (ARP) package file because the uri property was not specified.

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

Definitions

See Definitions

anti_ransomware_node

Name Type Description

name

string

Name of the node.

version

string

Anti-ransomware version.

anti_ransomware

Name Type Description

nodes

array[anti_ransomware_node]

uri

string

URI of the anti-ransomware package through a server

href

Name Type Description

href

string

_links

Name Type Description

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.