Create a file system snapshot
Creates a file system snapshot.
HTTP request syntax (URI)
POST <base_URI>/v8/storage/filesystem-snapshots
Parameters
| Name | Type | Required | Values | Description |
| filesystemId | BODY | Y | string | Either the file system object ID or HNAS file system ID. |
| displayName | BODY | Y | string | Display name of the snapshot to create. |
| appSearchId | BODY | Y | string | Application specific filter ID to speed up searching for future retrieval. TIP: This user-defined ID becomes the prefix of the snapshot display name when created. And it will speed up in subsequent queries. |
Return codes
| Code | Data | Description |
| 201 | snapshot | File system snapshot has been successfully created. |
| 400 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
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.57.75:8444/v8/storage/filesystem-snapshots -d '{"displayName":"snapshot-0917", "filesystemId":"748154E1A75B56600000000000000000","appSearchId":"xyz"}' -X POST
Response example
HTTP/1.1 201 Created
{
"snapshot" : {
"creationReason" : "SNAPSHOT_CREATED_BY_APPLICATION",
"creationTime" : 1476398487,
"displayName" : "xyz-snapshot-0917",
"filesystemId" : "748154E1A75B56600000000000000000",
"objectId" : "37343831353445314137354235363630303030303030303030303030303030303a3a3a4d6574726f2d78797a2d736e617073686f742d30393137",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
},
"uri" : "https://172.17.57.75:8444/v8/storage/filesystem-snapshots/37343831353445314137354235363630303030303030303030303030303030303a3a3a4d6574726f2d78797a2d736e617073686f742d30393137"
}