Skip to main content

List the snapshot policies associated with a system

Retrieves the snapshot policies associated with a system, returning the policies and their associated rules. Use this to view the snapshot policies created at the cluster level for the specified system.

HTTP method and endpoint

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/snapshot-policies

Token usage

NetApp Console user token.

Usage notes

Lists the snapshot policies associated with a system. The API lists the snapshot policies created on the cluster level for the specified system. The system ID is passed as a parameter for the API REST call. It returns the snapshot policies and the rules associated with the policies.

Parameters

Name Type In Required Description

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

System ID

authorization

string

header

True

User token

X-Agent-Id

string

header

True

Request identifier

Response

Status: 200, Default response
Name Type Required Description

snapshot-policy

array[snapshot-policy]

False

Example response
{
  "snapshot-policy": [
    {
      "id": "string",
      "name": "string",
      "rule": [
        {
          "retention": "string",
          "prefix": "string",
          "label": "string",
          "schedule-name": "string",
          "cron": {
            "minutes": [
              "integer"
            ],
            "hours": [
              "integer"
            ],
            "weekdays": [
              "integer"
            ],
            "days": [
              "integer"
            ],
            "months": [
              "integer"
            ]
          },
          "interval": "string"
        }
      ]
    }
  ]
}

Definitions

See Definitions

cron

Name Type Required Description

minutes

array[integer]

False

hours

array[integer]

False

weekdays

array[integer]

False

days

array[integer]

False

months

array[integer]

False

rule

Name Type Required Description

retention

string

False

prefix

string

False

label

string

False

schedule-name

string

False

cron

cron

False

interval

string

False

snapshot-policy

Name Type Required Description

id

string

False

name

string

False

rule

array[rule]

False