Update login banner
Update the login banner contents, and enabled state. If enabled, the login banner is presented to any user who connects to the system via SSH or via the GUI.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/file-devices/login-banner
Parameters
Name | Type | Required | Values | Description |
bannerContent | BODY | N | string | Content of the login banner. |
enabled | BODY | N | boolean | Enabled state of login banner. |
Return codes
Code | Data | Description |
204 | No Data | Login banner successfully updated. |
400 | Error Message | Missing or invalid request contents. |
403 | Error Message | Operation forbidden by access level. |
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
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/file-devices/login-banner -X PATCH -d '{"enabled":true, "bannerContent":"Welcome to the system\n\nPlease ensure you have the correct permission to access this system."}'
Response example
HTTP/1.1 204 No Content