Create a snapshot rule
Creates a snapshot rule for a filesystem ID.
HTTP request syntax (URI)
POST <base_URL>/v7/storage/snapshot-rules
Parameters
| Name | Type | Required | Values | Description |
| filesystemId | BODY | Y | string | ID of the file system for which the snapshot rule is created. |
| 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. The maximum is 1024 snapshots per rule. |
Return codes
| Code | Data | Description |
| 201 | filesystemSnapshotRule | Retrieves 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 201 indicates that the API did not complete successfully.
Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.239.120:8444/v7/storage/snapshot-rules -d ‘{"filesystemId": "8659E4DE8E2FF4EA0000000000000000", "snapshotRuleName":"rickSSRule", "queueSize":1}' -X POST
Response example
HTTP/1.1 201 Created
{
"filesystemSnapshotRule" : {
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "343a3a3a38363539453444453845324646344541303030303030303030303030303030303a3a3a7269636b535352756c65",
"isValid" : true,
"name" : "rickSSRule",
"queueSize" : 1,
"virtualServerId" : 4
},
"uri" : "https://172.17.239.120:8444/v7/storage/snapshot-rules/343a3a3a38363539453444453845324646344541303030303030303030303030303030303a3a3a7269636b535352756c65"
}