{"description":"api_smb_settings","type":"object","properties":{"session_encryption":{"type":"string","enum":["NONE","PREFERRED","REQUIRED"],"description":"Session-level encryption setting.:\n * `NONE` - Do not instruct clients to encrypt SMB traffic.,\n * `PREFERRED` - Instruct clients to encrypt SMB traffic if they support encryption.,\n * `REQUIRED` - Always instruct clients to encrypt SMB traffic. Reject clients who do not support encryption."},"supported_dialects":{"type":"array","items":{"type":"string","enum":["SMB2_DIALECT_2_002","SMB2_DIALECT_2_1","SMB2_DIALECT_3_0","SMB2_DIALECT_3_11"],"description":"supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"}},"hide_shares_from_unauthorized_users":{"description":"If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.","type":"boolean"},"hide_shares_from_unauthorized_hosts":{"description":"If share permissions deny a connected host access to a share, that share will not be visible in the share listing.","type":"boolean"},"snapshot_directory_mode":{"type":"string","enum":["VISIBLE","HIDDEN","DISABLED"],"description":"Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - .snapshot directories will not be accessible via SMB.,\n * `HIDDEN` - .snapshot directories will not be visible in directory listings, but may be opened by name.,\n * `VISIBLE` - A .snapshot directory will be visible when listing the root directory of a SMB share."},"bypass_traverse_checking":{"description":"Skip directory traversal checking for all users.","type":"boolean"},"signing_required":{"description":"Requires messages from non-guest users to be signed.","type":"boolean"}}}
PUT
Set settings for the SMB Server.
Parameters
Name
Description
Required
If-Match
ETag for expected version
No
Request
Schema
{"description":"api_smb_settings","type":"object","properties":{"session_encryption":{"type":"string","enum":["NONE","PREFERRED","REQUIRED"],"description":"Session-level encryption setting.:\n * `NONE` - Do not instruct clients to encrypt SMB traffic.,\n * `PREFERRED` - Instruct clients to encrypt SMB traffic if they support encryption.,\n * `REQUIRED` - Always instruct clients to encrypt SMB traffic. Reject clients who do not support encryption."},"supported_dialects":{"type":"array","items":{"type":"string","enum":["SMB2_DIALECT_2_002","SMB2_DIALECT_2_1","SMB2_DIALECT_3_0","SMB2_DIALECT_3_11"],"description":"supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"}},"hide_shares_from_unauthorized_users":{"description":"If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.","type":"boolean"},"hide_shares_from_unauthorized_hosts":{"description":"If share permissions deny a connected host access to a share, that share will not be visible in the share listing.","type":"boolean"},"snapshot_directory_mode":{"type":"string","enum":["VISIBLE","HIDDEN","DISABLED"],"description":"Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - .snapshot directories will not be accessible via SMB.,\n * `HIDDEN` - .snapshot directories will not be visible in directory listings, but may be opened by name.,\n * `VISIBLE` - A .snapshot directory will be visible when listing the root directory of a SMB share."},"bypass_traverse_checking":{"description":"Skip directory traversal checking for all users.","type":"boolean"},"signing_required":{"description":"Requires messages from non-guest users to be signed.","type":"boolean"}}}
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_smb_settings","type":"object","properties":{"session_encryption":{"type":"string","enum":["NONE","PREFERRED","REQUIRED"],"description":"Session-level encryption setting.:\n * `NONE` - Do not instruct clients to encrypt SMB traffic.,\n * `PREFERRED` - Instruct clients to encrypt SMB traffic if they support encryption.,\n * `REQUIRED` - Always instruct clients to encrypt SMB traffic. Reject clients who do not support encryption."},"supported_dialects":{"type":"array","items":{"type":"string","enum":["SMB2_DIALECT_2_002","SMB2_DIALECT_2_1","SMB2_DIALECT_3_0","SMB2_DIALECT_3_11"],"description":"supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"}},"hide_shares_from_unauthorized_users":{"description":"If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.","type":"boolean"},"hide_shares_from_unauthorized_hosts":{"description":"If share permissions deny a connected host access to a share, that share will not be visible in the share listing.","type":"boolean"},"snapshot_directory_mode":{"type":"string","enum":["VISIBLE","HIDDEN","DISABLED"],"description":"Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - .snapshot directories will not be accessible via SMB.,\n * `HIDDEN` - .snapshot directories will not be visible in directory listings, but may be opened by name.,\n * `VISIBLE` - A .snapshot directory will be visible when listing the root directory of a SMB share."},"bypass_traverse_checking":{"description":"Skip directory traversal checking for all users.","type":"boolean"},"signing_required":{"description":"Requires messages from non-guest users to be signed.","type":"boolean"}}}
PATCH
Partially set settings for the SMB Server.
Parameters
Name
Description
Required
If-Match
ETag for expected version
No
Request
Schema
{"description":"api_smb_settings_patch","type":"object","properties":{"session_encryption":{"type":"string","enum":["NONE","PREFERRED","REQUIRED"],"description":"Session-level encryption setting.:\n * `NONE` - Do not instruct clients to encrypt SMB traffic.,\n * `PREFERRED` - Instruct clients to encrypt SMB traffic if they support encryption.,\n * `REQUIRED` - Always instruct clients to encrypt SMB traffic. Reject clients who do not support encryption."},"supported_dialects":{"type":"array","items":{"type":"string","enum":["SMB2_DIALECT_2_002","SMB2_DIALECT_2_1","SMB2_DIALECT_3_0","SMB2_DIALECT_3_11"],"description":"supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"}},"hide_shares_from_unauthorized_users":{"description":"If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.","type":"boolean"},"hide_shares_from_unauthorized_hosts":{"description":"If share permissions deny a connected host access to a share, that share will not be visible in the share listing.","type":"boolean"},"snapshot_directory_mode":{"type":"string","enum":["VISIBLE","HIDDEN","DISABLED"],"description":"Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - .snapshot directories will not be accessible via SMB.,\n * `HIDDEN` - .snapshot directories will not be visible in directory listings, but may be opened by name.,\n * `VISIBLE` - A .snapshot directory will be visible when listing the root directory of a SMB share."},"bypass_traverse_checking":{"description":"Skip directory traversal checking for all users.","type":"boolean"},"signing_required":{"description":"Requires messages from non-guest users to be signed.","type":"boolean"}}}
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_smb_settings","type":"object","properties":{"session_encryption":{"type":"string","enum":["NONE","PREFERRED","REQUIRED"],"description":"Session-level encryption setting.:\n * `NONE` - Do not instruct clients to encrypt SMB traffic.,\n * `PREFERRED` - Instruct clients to encrypt SMB traffic if they support encryption.,\n * `REQUIRED` - Always instruct clients to encrypt SMB traffic. Reject clients who do not support encryption."},"supported_dialects":{"type":"array","items":{"type":"string","enum":["SMB2_DIALECT_2_002","SMB2_DIALECT_2_1","SMB2_DIALECT_3_0","SMB2_DIALECT_3_11"],"description":"supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"}},"hide_shares_from_unauthorized_users":{"description":"If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.","type":"boolean"},"hide_shares_from_unauthorized_hosts":{"description":"If share permissions deny a connected host access to a share, that share will not be visible in the share listing.","type":"boolean"},"snapshot_directory_mode":{"type":"string","enum":["VISIBLE","HIDDEN","DISABLED"],"description":"Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - .snapshot directories will not be accessible via SMB.,\n * `HIDDEN` - .snapshot directories will not be visible in directory listings, but may be opened by name.,\n * `VISIBLE` - A .snapshot directory will be visible when listing the root directory of a SMB share."},"bypass_traverse_checking":{"description":"Skip directory traversal checking for all users.","type":"boolean"},"signing_required":{"description":"Requires messages from non-guest users to be signed.","type":"boolean"}}}
