Set FTP config for a virtual server
Sets FTP configuration parameters for a virtual server.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/virtual-servers/{virtualServerId}/ftp
Parameters
| Name | Type | Required | Values | Description |
| virtualServerId | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
| anonymousReadOnly | BODY | N | boolean | True restricts anonymous sessions to read-only access. False allows anonymous users read-write access. |
| timeout | BODY | N | integer | Set the FTP session inactivity time-out value in minutes. |
| useNisSecurity | BODY | N | boolean | True to use NIS authentication for FTP. |
| useNtSecurity | BODY | N | boolean | True to use NT (Windows) authentication for FTP. |
Return codes
| Code | Data | Description |
| 204 | No Data | FTP config 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: Set anonymous access to read-only
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/virtual-servers/4/ftp -X PATCH -d '{"anonymousReadOnly":true}'
Response example
HTTP/1.1 204 No Content