Skip to main content
REST API reference

Retrieve anti-ransomware auto enablement values

PDFs

GET /security/anti-ransomware/auto-enable

Introduced In: 9.18

Retrieves the current anti-ransomware auto enablement values, including details about warm-up period and auto enablement setting for new and existing volumes.

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

new_volume_auto_enable

boolean

Auto Anti-Ransomware Protection (ARP) setting for new volumes.

warm_up_period_applicable

boolean

Indicates if the warm-up period is applicable.

warm_up_period_completed

boolean

Indicates if warm-up period has completed.

warm_up_period_remaining_duration

string

Time remaining for warm-up period completion.

warm_up_period_total_duration

string

Duration of warm-up period.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "warm_up_period_remaining_duration": "string",
  "warm_up_period_total_duration": "string"
}

Error

Status: Default, Error
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
Name Type Description

self

href

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.