Skip to main content
ONTAP REST API reference

Update a volume snapshot

Contributors
PDFs

PATCH /storage/volumes/{volume.uuid}/snapshots/{uuid}

Introduced In: 9.6

Updates a Volume snapshot.

  • snapshot modify

  • snapshot rename

Learn more

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

uuid

string

path

True

Snapshot UUID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

_links

_links

comment

string

A comment associated with the snapshot. This is an optional attribute for POST or PATCH.

compress_savings

integer

Savings due to compression at the time the snapshot was taken in bytes.

create_time

string

Creation time of the snapshot. It is the volume access time when the snapshot was created.

dedup_savings

integer

Savings due to dedup at the time the snapshot was taken in bytes.

delta

snapshot_delta

Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a snapshot and the Active File System, only the snapshot name needs to be mentioned.

expiry_time

string

The expiry time for the snapshot. This is an optional attribute for POST or PATCH. Snapshots with an expiry time set are not allowed to be deleted until the retention time is reached.

logical_size

integer

Size of the logical used file system at the time the snapshot is captured.

name

string

Snapshot. Valid in POST or PATCH.

owners

array[string]

provenance_volume

provenance_volume

reclaimable_space

integer

Space reclaimed when the snapshot is deleted, in bytes.

size

integer

Size of the active file system at the time the snapshot is captured. The actual size of the snapshot also includes those blocks trapped by other snapshots. On a snapshot deletion, the "size" amount of blocks is the maximum number of blocks available. On a snapshot restore, the "afs-used size" value will match the snapshot "size" value.

snaplock

snaplock

snaplock_expiry_time

string

SnapLock expiry time for the snapshot, if the snapshot is taken on a SnapLock volume. A snapshot is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time. This option can be set during snapshot POST and snapshot PATCH on snapshot locking enabled volumes. This field will no longer be supported in a future release. Use snaplock.expiry_time instead.

snapmirror_label

string

Label for SnapMirror operations

state

string

State of the FlexGroup volume snapshot. In the "pre_conversion" state, the snapshot was created before converting the FlexVol to a FlexGroup volume. A recently created snapshot can be in the "unknown" state while the system is calculating the state. In the "partial" state, the snapshot is consistent but exists only on the subset of the constituents that existed prior to the FlexGroup's expansion. Partial snapshots cannot be used for a snapshot restore operation. A snapshot is in an "invalid" state when it is present in some FlexGroup constituents but not in others. At all other times, a snapshot is valid.

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

The UUID of the snapshot in the volume that uniquely identifies the snapshot in that volume.

vbn0_savings

integer

Savings due vbn0 at the time the snapshot was taken in bytes.

version_uuid

string

The 128 bit identifier that uniquely identifies a snapshot and its logical data layout.

volume

volume
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "compress_savings": 1131223,
  "create_time": "2019-02-04 14:00:00 -0500",
  "dedup_savings": 1131223,
  "delta": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "size_consumed": 0,
    "time_elapsed": "string"
  },
  "expiry_time": "2019-02-04 14:00:00 -0500",
  "logical_size": 1228800,
  "name": "this_snapshot",
  "owners": [
    "string"
  ],
  "provenance_volume": {
    "uuid": "4cd8a442-86d1-11e0-ae1c-125648563413"
  },
  "size": "122880",
  "snaplock": {
    "expired": 1,
    "expiry_time": "2019-02-04 14:00:00 -0500",
    "time_until_expiry": "PT3H27M45S"
  },
  "snaplock_expiry_time": "2019-02-04 14:00:00 -0500",
  "snapmirror_label": "string",
  "state": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "vbn0_savings": 1131223,
  "version_uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Code

Error Code Description

524508

The snapshot was not renamed because the name entered is not valid.

542797

The specified file or snapshot does not exist.

1638455

Failed to set comment for snapshot.

1638476

You cannot rename a snapshot created for use as a reference snapshot by other jobs.

1638477

User-created snapshot names cannot begin with the specified prefix.

1638518

The specified snapshot name is invalid.

1638522

Snapshots can only be renamed on read/write (RW) volumes.

1638523

Failed to set the specified SnapMirror label for the snapshot.

1638524

Adding SnapMirror labels is not allowed in a mixed version cluster.

1638539

Cannot determine the status of the snapshot rename operation for the specified volume.

1638554

Failed to set expiry time for the snapshot.

1638600

The snapshot does not exist.

1638644

POST, DELETE, and PATCH requests on the snapshot session endpoint are not supported on this platform.
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

_links

Name Type Description

self

href

snapshot_delta

Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a snapshot and the Active File System, only the snapshot name needs to be mentioned.

Name Type Description

_links

_links

size_consumed

integer

Indicates the space that has changed between two specified WAFL file systems, in bytes.

time_elapsed

string

Time elapsed between two specified WAFL file systems.

provenance_volume

Name Type Description

uuid

string

UUID for the volume that is used to identify the source volume in a mirroring relationship. When the mirroring relationship is broken, a volume's Instance UUID and Provenance UUID are made identical. An unmirrored volume's Provenance UUID is the same as its Instance UUID. This field is valid for flexible volumes only.

snaplock

Name Type Description

expired

boolean

Indicates whether a SnapLock snapshot has expired.

expiry_time

string

SnapLock expiry time for the snapshot, if the snapshot is taken on a SnapLock volume. A snapshot is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time. This option can be set during snapshot POST and snapshot PATCH on snapshot locking enabled volumes. It can also be used to extend the expiry time of a locked snapshot on a SnapLock for SnapVault destination consistency-group.

time_until_expiry

string

Indicates the remaining SnapLock expiry time of a locked snapshot, in seconds. This field is set only when the remaining time interval is less than 136 years.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

volume

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a PATCH method.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

snapshot

The snapshot object represents a point in time snapshot of a volume.

Name Type Description

_links

_links

comment

string

A comment associated with the snapshot. This is an optional attribute for POST or PATCH.

compress_savings

integer

Savings due to compression at the time the snapshot was taken in bytes.

create_time

string

Creation time of the snapshot. It is the volume access time when the snapshot was created.

dedup_savings

integer

Savings due to dedup at the time the snapshot was taken in bytes.

delta

snapshot_delta

Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a snapshot and the Active File System, only the snapshot name needs to be mentioned.

expiry_time

string

The expiry time for the snapshot. This is an optional attribute for POST or PATCH. Snapshots with an expiry time set are not allowed to be deleted until the retention time is reached.

logical_size

integer

Size of the logical used file system at the time the snapshot is captured.

name

string

Snapshot. Valid in POST or PATCH.

owners

array[string]

provenance_volume

provenance_volume

reclaimable_space

integer

Space reclaimed when the snapshot is deleted, in bytes.

size

integer

Size of the active file system at the time the snapshot is captured. The actual size of the snapshot also includes those blocks trapped by other snapshots. On a snapshot deletion, the "size" amount of blocks is the maximum number of blocks available. On a snapshot restore, the "afs-used size" value will match the snapshot "size" value.

snaplock

snaplock

snaplock_expiry_time

string

SnapLock expiry time for the snapshot, if the snapshot is taken on a SnapLock volume. A snapshot is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time. This option can be set during snapshot POST and snapshot PATCH on snapshot locking enabled volumes. This field will no longer be supported in a future release. Use snaplock.expiry_time instead.

snapmirror_label

string

Label for SnapMirror operations

state

string

State of the FlexGroup volume snapshot. In the "pre_conversion" state, the snapshot was created before converting the FlexVol to a FlexGroup volume. A recently created snapshot can be in the "unknown" state while the system is calculating the state. In the "partial" state, the snapshot is consistent but exists only on the subset of the constituents that existed prior to the FlexGroup's expansion. Partial snapshots cannot be used for a snapshot restore operation. A snapshot is in an "invalid" state when it is present in some FlexGroup constituents but not in others. At all other times, a snapshot is valid.

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

The UUID of the snapshot in the volume that uniquely identifies the snapshot in that volume.

vbn0_savings

integer

Savings due vbn0 at the time the snapshot was taken in bytes.

version_uuid

string

The 128 bit identifier that uniquely identifies a snapshot and its logical data layout.

volume

volume
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.