CreateShareRequest

nameShareNamerequired

A share name is a single path segment on every branch and under /mnt/user.

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[a-zA-Z0-9][a-zA-Z0-9_-]*$

cacheModeShareCacheMode

Per-share cache mode.

Possible values: [cache-then-move, cache-only, array-only]

createPolicyArrayCreatePolicy

Default mergerfs create policy for new shares.

Possible values: [mspmfs, mfs, lfs, ff]

smb object

enabledbooleanrequired

guestbooleanrequired

readOnlybooleanrequired

browseablebooleanrequired

recyclebooleanrequired

timeMachinebooleanrequired

timeMachineMaxSizestring | nullnullable

Samba fruit:time machine max size, e.g. 500G. Required when timeMachine is true; omitted otherwise.

nfs object

enabledbooleanrequired

hostsstring[]required

Allowed NFS clients: DNS hostnames, IPv4 or IPv6 addresses, or CIDR subnets. Required when enabled is true.

Possible values: non-empty and <= 253 characters

squashstringrequired

NFS squash option.

Possible values: [root_squash, no_root_squash, all_squash]

fsidstring<uuid>

The fsid= value written for this share's NFS export line. Derived from the share name only; ignored on a create or update request. Always present on a response — a draft preview can use the saved share's fsid because a share cannot be renamed.

CreateShareRequest

{
  "name": "string",
  "cacheMode": "cache-then-move",
  "createPolicy": "mspmfs",
  "smb": {
    "enabled": true,
    "guest": true,
    "readOnly": true,
    "browseable": true,
    "recycle": true,
    "timeMachine": true,
    "timeMachineMaxSize": "string"
  },
  "nfs": {
    "enabled": true,
    "hosts": [
      "string"
    ],
    "squash": "root_squash",
    "fsid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}