Skip to main content
Hitachi Vantara Knowledge

Modify a snapshot rule

Modifies a snapshot rule for a filesystem ID.

HTTP request syntax (URI)
PATCH <base_URI>/v7/storage/snapshot-rules/{snapshotRuleObjectId}
Name Type Required Values Description
snapshotRuleObjectId URI_PARAM Y string ID of the snapshot rule object.
snapshotRuleName BODY Y string Name of the snapshot rule.
queueSize BODY Y number The maximum number of snapshots that can be created by this rule. When the maximum number has been reached, the newest snapshot overwrites the oldest one.
Return codes
Code Data Description
303 filesystemSnapshotRule Updates a file system snapshot rule.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 303 indicates that the operation did not complete successfully.

Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" -d '{"snapshotRuleName":"user1-Snapshot-Rule", "queueSize":3}' -X PATCH 
Response example
HTTP/1.1 303 See Other
   "filesystemSnapshotRule" : {
      "filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
      "objectId" : "343a3a3a38363539453444453845324646344541303030303030303030303030303030303a3a3a4875616e2d536e617073686f742d52756c65",
      "isValid" : true,
      "name" : "user1-Snapshot-Rule",
      "queueSize" : 3,
      "virtualServerId" : 4
   "uri" : ""


  • Was this article helpful?