Create share

SecurityAuthToken
Request
path Parameters
volume_guid
required
string

Volume identifier

filer_serial
required
string

Filer object identifier

Request Body schema: application/json
required

The share to create.

name
required
string

The name of the CIFS share.

path
required
string

Path of the share.

comment
string

Any comments regarding the share.

readonly
boolean
Default: false

If enabled, users can not change the contents of the share.

browseable
boolean
Default: true

If enabled, this share will appear when browsing.

hosts_allow
string
Default: ""

Hosts allowed to access the share. IP addresses or IP address/netmask values separated by spaces. Blank allows all hosts

hide_unreadable
boolean
Default: true

Files and folders that the user cannot access do not appear in folder listings.

enable_previous_vers
boolean
Default: false

Allow users to view and restore files using the Previous Versions tab in Windows

case_sensitive
boolean
Default: false

Files and folders are considered different if the case of letters in the name differs. (Enabling case sensitivity aids performance)

enable_snapshot_dirs
boolean
Default: false

Allows clients to access the hidden snapshot directories, showing previous versions of the file system (requires enabling Snapshot Directory Access for the volume).

homedir_support
integer

When enabled, the target folder path for the share is automatically appended with a folder named for the user. Possible values:

  • 0 - Disable
  • 2 - Enable
mobile
boolean
Default: false

Enable desktop and/or mobile device support

browser_access
boolean
Default: false

Enable web access

object

Settings that can be applied to web access.

aio_enabled
boolean
Default: true

Asynchronous I/O. Enable concurrent read/write access per client connection.

veto_files
string
Default: ""

Block files. Specify file or directory name patterns that the share will make both invisible and inaccessible. Enter one pattern per line. The wildcard characters '*' and '?' may be used to specify multiple files or directories. The '/' character is not valid. Note: This feature can break compatibility with some clients.

fruit_enabled
boolean
Default: false

Enhances share behavior, including SMB2 protocol support, for Mac OS X Clients when possible.

smb_encrypt
string
Default: ""

Control if clients are desired or required to use SMB encryption when connecting to the share. Includes SMB3 encryption for Windows clients. Empty string indicates that client usage of encryption is optional.

Enum: "" "desired" "required"
agl_oplocks
boolean
Default: true

Enable Oplocks for Advanced Global Locking. This supports client read caching and can accelerate some applications. Only applies to 9.12+ Filers

object

Share authentication settings.

Responses
202

Accepted - Filer has been sent a message

400

Validation error

401

Authentication failure

403

Permission denied

429

Request throttled

post/volumes/{volume_guid}/filers/{filer_serial}/shares/
Request samples
application/json
{
  • "name": "string",
  • "path": "string",
  • "comment": "string",
  • "readonly": false,
  • "browseable": true,
  • "hosts_allow": "",
  • "hide_unreadable": true,
  • "enable_previous_vers": false,
  • "case_sensitive": false,
  • "enable_snapshot_dirs": false,
  • "homedir_support": 0,
  • "mobile": false,
  • "browser_access": false,
  • "browser_access_settings": {
    },
  • "aio_enabled": true,
  • "veto_files": "",
  • "fruit_enabled": false,
  • "smb_encrypt": "",
  • "agl_oplocks": true,
  • "auth": {
    }
}
Response samples
application/json
{
  • "message": {
    }
}
Copyright © 2025 Nasuni Corporation. All rights reserved.