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

Update the retention period of an EBR policy

PDFs

PATCH /storage/snaplock/event-retention/policies/{policy.name}

Introduced In: 9.7

Updates the retention period of an Event Based Retention (EBR) policy.

  • snaplock event-retention policy modify

Example

Updates the retention period of an EBR policy "policy_name":

PATCH "/api/storage/snaplock/event-retention/policies/" '{"name": "policy_name","retention_period": "P20Y"}'

Learn more

Parameters

Name Type In Required Description

policy.name

string

path

True

Name of the retention policy

Request Body

Name Type Description

name

string

Specifies the EBR policy name

retention_period

string

Specifies the retention period of an event based retention policy. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours or minutes. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. Similarly, a duration in hours, minutes is represented by "PTH", "PTM" respectively. The period string must contain only a single time element i.e. either years, months, days, hours or minutes. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the strings "infinite" and "unspecified".

svm

svm
Example request 
{
  "name": "string",
  "retention_period": "P30M",
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Error

Status: Default, Error

Definitions

See Definitions

href

Name Type Description

href

string

_links

svm

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

snaplock_retention_policy

Name Type Description

name

string

Specifies the EBR policy name

retention_period

string

Specifies the retention period of an event based retention policy. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours or minutes. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. Similarly, a duration in hours, minutes is represented by "PTH", "PTM" respectively. The period string must contain only a single time element i.e. either years, months, days, hours or minutes. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the strings "infinite" and "unspecified".

svm

svm

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.