Gets a root file system directory.
HTTP request syntax (URI)
GET <base_URI>/v7/storage/filesystems/{id}/directories
Parameters
Name | Type | Required | Values | Description |
---|---|---|---|---|
id | URI_PARAM | Y | string | Specifies either the object ID of the file system or the HNAS file system ID to create a directory. |
Return codes
Code | Data | Description |
---|---|---|
200 | directory | Array of immediate sub-directories. |
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 200 indicates that the API did not complete successfully.
Request example: Using the file system object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/4141394239423945344644383541464430303030303030303030303030303030/directories
Response example: Using the file system object ID
HTTP/1.1 200 OK { "directories" : [ { "displayName" : [ "//$__NDMP__" ], "objectId" : "245f5f4e444d505f5f" }, { "displayName" : [ "//$__CFN__" ], "objectId" : "245f5f43464e5f5f" }, { "displayName" : [ "//sharenamed" ], "objectId" : "736573686172656e616d6564" } ]
Request example: Using the HNAS storage file system ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/864DC6E1DFB68C210000000000000000/directories
Response example: Using the HNAS storage file system ID
HTTP/1.1 200 OK { "directories" : [ { "displayName" : [ "//$__NDMP__" ], "objectId" : "245f5f4e444d505f5f" }, { "displayName" : [ "//$__CFN__" ], "objectId" : "245f5f43464e5f5f" }, { "displayName" : [ "//sharenamed" ], "objectId" : "736573686172656e616d6564" } ] }