Update a file system share
Updates a file system share.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/filesystem-shares/{type}/{filesystemShareObjectId}
Parameters
| Name | Type | Required | Values | Description |
| filesystemShareObjectId | URI_PARAM | Y | string | Object ID of the file system share. |
| type | URI_PARAM | Y | string | Possible values are cifs or nfs. |
| filesystemId | BODY | Y | string | Either the file system object ID or HNAS file system ID. |
| filesystemPath | BODY | Y | string | Absolute filesystem path where the share resides - for NFS exports, the path should be UNIX format, for CIFS shares the path should be Windows format, and the \ character needs to be escaped |
| settings | BODY | Y | object | Share setting. Depending which file system type specified, the object is either NFS settings or CIFS settings. |
Return codes
| Code | Data | Description |
| 204 | No Data | File system share was successfully updated |
| 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 204 indicates that the API did not complete successfully.
Request example 1: Update CIFS/SMB share
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/storage/filesystem-shares/cifs/353a3a3a65646430653862322d353462612d313164312d393131622d34626565336661616363362 -d '{"filesystemId":"7547FEE51E4FEC080000000000000000", "filesystemPath":"\\", "settings":{"accessConfig":"*", "comment":"xyz comment", "userHomeDirectoryPath":"", "isScanForVirusesEnabled":false, "maxConcurrentUsers":100, "snapshotOption":"SHOW_AND_ALLOW_ACCESS", "cacheOption":"MANUAL_CACHING_DOCS", "transferToReplicationTargetSetting":"DO_NOT_TRANSFER", "userHomeDirectoryMode":"OFF", "isFollowSymbolicLinks":false, "isFollowGlobalSymbolicLinks":false, "isForceFileNameToLowerCase":false, "isABEEnabled":true}}' -X PATCH
Response example 1
HTTP/1.1 204 No Content
Request example 2: Update NFS export
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/storage/filesystem-shares/nfs/353a3a3a65646430653862322d353462612d313164312d393131622d346265653366616163613362 -d '{"filesystemId":"75412709E1CB9AAB0000000000000000", "filesystemPath":"/xyz/doc/test/path/0426", "settings":{"accessConfig":"*", "snapshotOption":"SHOW_AND_ALLOW_ACCESS", "localReadCacheOption":"DISABLED", "transferToReplicationTargetSetting":"DO_NOT_TRANSFER"}}' -X PATCH
Response example 2
HTTP/1.1 204 No Content