Skip to main content

Update a protection policy in NetApp Console local deployment

PATCH /v1/organizations/{organizationId}/protectionpolicies/{protectionPolicyId}

Modifies an existing protection policy. Include only the fields you want to update in the request. The protection policy can only be modified if there is no workload associated with it and it is not system-defined.

Parameters

Name Type In Required Description

organizationId

string

path

True

Organization ID

protectionPolicyId

string

path

True

Protection policy ID

  • example: 4fa85f64-5717-4562-b3fc-2c963f66afa7

Request Body

Name Type Required Description

description

string

False

Protection policy description.

name

string

False

Protection policy name.

snapshotSchedules

array[snapshotSchedules]

False

Array of snapshot schedule objects used to create local snapshot policies.

tags

array[tags]

False

JSON array of tags (name/value pairs) associated with the performance policy. Can be used to add any additional data related to the performance policy.

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.protectionpolicy"

version

string

True

Version of the resource schema. Defined values are:

  • "1.0"
Example request 
{
  "name": "New Policy Name",
  "snapshotSchedules": [
    {
      "retentionCount": 48,
      "schedule": "HOURLY"
    },
    {
      "retentionCount": 7,
      "schedule": "DAILY"
    }
  ]
}

Response

Status: 204, Protection policy updated successfully.

Error

Status: 400, Bad request
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 401, Unauthorized
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Error

Status: 404, Not found
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404",
  "title": "Collection not found",
  "type": "https://bluexp.netapp.io/problems/2"
}

Error

Status: 409, Conflict
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409",
  "title": "JSON resource conflict",
  "type": "https://bluexp.netapp.io/problems/10"
}

Definitions

See Definitions

snapshotSchedules

Name Type Required Description

retentionCount

integer

True

Number of snapshots to be retained for a schedule.

schedule

string

True

Snapshot schedule frequency.

tags Hash mapping strings to string

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.