Skip to main content

Retrieve ONTAP backup policies

Contributors

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

Retrieves a list of ONTAP backup policies associated with a working environment. 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: BlueXP user token.

Parameters

Name Type In Required Description

archived

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",
      "rule": [
        {
          "label": "string",
          "retention": "string",
          "period": "string"
        }
      ],
      "attached-volumes-count": "string",
      "archive-after-days": "string",
      "object-lock": "string"
    }
  ]
}

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

period

string

False

backup-policy

Name Type Required Description

name

string

False

rule

array[rule]

False

attached-volumes-count

string

False

archive-after-days

string

False

object-lock

string

False