Skip to main content

Share

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_-]*$

pathstringrequired

The share's mount path (/mnt/user/<name>).

cacheModeShareCacheModerequired

Per-share cache mode.

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

createPolicyArrayCreatePolicyrequired

Default mergerfs create policy for new shares.

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

smb objectrequired
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 objectrequired
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.

usage objectrequired

Null when this share has not been through a sync since it was created — an honest "not yet synced" state, never a zero or placeholder that looks like real data.

oneOf

Bytes used and per-disk distribution as of the last sync — computed once as a step of the sync job, from SnapRAID's own tracked state, never a live directory walk.

totalBytesinteger<int64>required

Possible values: >= 0

perDisk object[]required

Which disks currently hold this share's files, and how much. A disk this share does not currently occupy is simply absent, not a zero entry.

  • Array [
    • diskstringrequired

    Data disk mount point currently holding files for this share.

    bytesinteger<int64>required

    Possible values: >= 0

  • ]
    • asOfstring<date-time>required

    When the sync that produced these figures completed.

    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    minFreeSpacestring

    The share's own mergerfs minfreespace, such as 1000K. Absent when the share uses the array's. An Unraid import sets it from the share's floor.

    migration object

    What the Unraid import recorded about a share it created. Absent on a share the import did not create.

    targetCacheModeShareCacheMode

    Per-share cache mode.

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

    notesstring[]required

    What could not be mapped exactly, in plain language: High-water allocation mapped to Balance across disks, a split level Hoserva has no setting for, a security mode it has no equivalent of.

    Share
    {
      "name": "string",
      "path": "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"
      },
      "usage": {
        "totalBytes": 0,
        "perDisk": [
          {
            "disk": "string",
            "bytes": 0
          }
        ],
        "asOf": "2024-07-29T15:51:28.071Z"
      },
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "minFreeSpace": "string",
      "migration": {
        "targetCacheMode": "cache-then-move",
        "notes": [
          "string"
        ]
      }
    }