Skip to main content

Retrieve ONTAP backup policies

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/backup-policy

Retrieves a list of ONTAP backup policies associated with a system. You can filter the policies based on the archival enablement status. This API endpoint retrieves the backup-policy name, rule, attached volume count, archive-after-days, and object-lock mode information.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

archived

boolean

query

False

is-mcc-cluster

boolean

query

False

partial

boolean

query

False

accountId

string

path

True

workingEnvironmentId

string

path

True

authorization

string

header

True

X-Agent-Id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

backup-policy

array[backup-policy]

False
Example response 
{
  "backup-policy": [
    {
      "name": "string",
      "id": "string",
      "rule": [
        {
          "label": "string",
          "retention": "string",
          "period": "string"
        }
      ],
      "attached-volumes-count": "string",
      "archive-after-days": "string",
      "object-lock": "string",
      "transfer-schedule": {
        "uuid": "string",
        "name": "string",
        "cron": {
          "minutes": [
            "integer"
          ],
          "hours": [
            "integer"
          ],
          "weekdays": [
            "integer"
          ],
          "days": [
            "integer"
          ],
          "months": [
            "integer"
          ]
        },
        "interval": "string"
      }
    }
  ]
}

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

period

string

False

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

transfer-schedule

Name Type Required Description

uuid

string

False

name

string

False

cron

cron

False

interval

string

False

backup-policy

Name Type Required Description

name

string

False

id

string

False

rule

array[rule]

False

attached-volumes-count

string

False

archive-after-days

string

False

object-lock

string

False

transfer-schedule

transfer-schedule

False

allow-policy-deletion

boolean

False