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

Retrieve snapshot policy schedules

Accesses snapshot policy schedules to view the timing configurations for snapshot creation within your storage system. This information helps you manage and verify schedule settings for data protection workflows.

HTTP method and endpoint

GET /storage/snapshot-policies/{snapshot_policy.uuid}/schedules

Introduced in

ONTAP 9.8

Usage notes

Retrieves a collection of snapshot policy schedules.

  • snapshot policy show

Parameters

Name Type In Required Description

snapshot_policy.uuid

string

path

True

Snapshot policy UUID

snapshot_policy.name

string

query

False

Filter by snapshot_policy.name

snapmirror_label

string

query

False

Filter by snapmirror_label

retention_period

string

query

False

Filter by retention_period

  • Introduced in: 9.12

schedule.name

string

query

False

Filter by schedule.name

schedule.uuid

string

query

False

Filter by schedule.uuid

count

integer

query

False

Filter by count

prefix

string

query

False

Filter by prefix

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: 15

  • 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_schedule]

Example response
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "prefix": "string",
      "retention_period": "string",
      "schedule": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "weekly",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "snapmirror_label": "string",
      "snapshot_policy": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "default",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_error

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

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

next

href

self

href

Name Type Description

self

href

schedule

Name Type Description

_links

_links

name

string

Job schedule name

uuid

string

Job schedule UUID

snapshot_policy

This is a reference to the snapshot policy.

Name Type Description

_links

_links

name

string

uuid

string

snapshot_policy_schedule

The snapshot policy schedule object is associated with a snapshot policy and it defines the interval at which snapshots are created and deleted.

Name Type Description

_links

_links

count

integer

The number of snapshots to maintain for this schedule.

prefix

string

The prefix to use while creating snapshots at regular intervals.

retention_period

string

The retention period of snapshots for this schedule.

schedule

schedule

snapmirror_label

string

Label for SnapMirror operations

snapshot_policy

snapshot_policy

This is a reference to the snapshot policy.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.