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

Retrieve Snapshot copy policies

Contributors
PDFs

GET /storage/snapshot-policies

Introduced In: 9.6

Retrieves a collection of Snapshot copy policies.

  • snapshot policy show

Learn more

Parameters

Name Type In Required Description

enabled

boolean

query

False

Filter by enabled

uuid

string

query

False

Filter by uuid

copies.snapmirror_label

string

query

False

Filter by copies.snapmirror_label

copies.schedule.name

string

query

False

Filter by copies.schedule.name

copies.count

integer

query

False

Filter by copies.count

copies.prefix

string

query

False

Filter by copies.prefix

name

string

query

False

Filter by name

comment

string

query

False

Filter by comment

scope

string

query

False

Filter by scope

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[snapshot_policy]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "copies": [
        {
          "prefix": "string",
          "schedule": {
            "name": "hourly"
          },
          "snapmirror_label": "string"
        }
      ],
      "enabled": 1,
      "name": "default",
      "scope": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}
JSON
Copy

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}
JSON
Copy

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

schedule

Name Type Description

name

string

Schedule at which Snapshot copies are captured on the volume. Some common schedules already defined in the system are hourly, daily, weekly, at 15 minute intervals, and at 5 minute intervals. Snapshot copy policies with custom schedules can be referenced.

copies

Name Type Description

count

integer

The number of Snapshot copies to maintain for this schedule.

prefix

string

The prefix to use while creating Snapshot copies at regular intervals.

schedule

schedule

snapmirror_label

string

Label for SnapMirror operations

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

snapshot_policy

The Snapshot copy policy object is associated with a read-write volume used to create and delete Snapshot copies at regular intervals.

Name Type Description

_links

_links

comment

string

A comment associated with the Snapshot copy policy.

copies

array[copies]

enabled

boolean

Is the Snapshot copy policy enabled?

name

string

Name of the Snapshot copy policy.

scope

string

Set to "svm" when the request is on a data SVM, otherwise set to "cluster".

svm

svm

uuid

string

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.