Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-034240919.6 KB
SMB

Get an smb share

    Get an smb share by cluster and share id
get/api/smb/share/{cluster_id}/{share_id}

Path parameters

cluster_idstring required

Unique identifier for the cluster

share_idstring required

Unique identifier for the share

Response

OK

browseableboolean required

Indicates if the share is browseable

cluster_idstring required

Unique identifier for the cluster

intentstring required

Desired state of the resource, e.g., 'present' or 'removed'

namestring required

Name of the share

read_bw_limitinteger required

QoS: max read bandwidth B/s (0=disabled)

read_delay_maxinteger required

QoS: max read delay in seconds (0-300)

read_iops_limitinteger required

QoS: max read IOPS (0=disabled)

readonlyboolean required

Indicates if the share is read-only

resource_typestring required

ceph.smb.share

share_idstring required

Unique identifier for the share

write_bw_limitinteger required

QoS: max write bandwidth B/s (0=disabled)

write_delay_maxinteger required

QoS: max write delay in seconds (0-300)

write_iops_limitinteger required

QoS: max write IOPS (0=disabled)