Auth3

Cephfs21

CephfsMirror15

CephfsSnapshotClone1

CephFSSnapshotSchedule6

CephFSSubvolume8

CephfsSubvolumeGroup5

CephfsSubvolumeSnapshot4

Cluster7

ClusterConfiguration6

CrushRule4

Daemon2

ErasureCodeProfile4

FeatureTogglesEndpoint1

Grafana3

Hardware1

Health6

Host10

Iscsi2

IscsiTarget5

Logs1

MdsPerfCounter1

MgrModule6

MgrPerfCounter1

Monitor1

MonPerfCounter1

Motd2

Multi-cluster9

NFS-Ganesha6

NVMe-oF Gateway10

NVMe-oF SPDK3

NVMe-oF Subsystem5

NVMe-oF Subsystem Connection1

NVMe-oF Subsystem Host Allowlist7

NVMe-oF Subsystem Listener3

NVMe-oF Subsystem Namespace19

OSD20

OsdPerfCounter1

PerfCounters1

Pool6

Prometheus10

PrometheusNotifications1

Rbd10

RbdGroup7

RbdGroupSnapshot6

RbdMirroring2

RbdMirroringPoolBootstrap2

RbdMirroringPoolMode2

RbdMirroringPoolPeer5

RbdMirroringSummary2

RbdNamespace3

RbdSnapshot5

RbdTrash4

Report5

RGW5

RGW Topic Management4

RgwBucket17

RgwDaemon3

RgwMirrorPerfCounter1

RgwMultisite10

RgwPerfCounter1

RgwRealm8

RgwSite1

RgwUser17

RgwUserAccounts8

RgwZone11

RgwZonegroup10

Role6

Service10

Settings5

SMB17

Summary1

Task1

TcmuRunnerPerfCounter1

Telemetry2

Upgrade6

User5

UserChangePassword1

UserPasswordPolicy1

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

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)

Changes

Changed in 7 of the 57 revisions of this API.3648

Mar 7, 2026d8047466225e12See the full diff
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
Mar 3, 2026b6628a2527a612See the full diff
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
Mar 3, 2026f13a8652bbf612See the full diff
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
Feb 13, 20261a8f7c621d1712See the full diff
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
Feb 13, 20268391fe34c23b12See the full diff
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
Feb 11, 202619a8e9b4a2c112See the full diff
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property read_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_bw_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_delay_max from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/json)
  response-required-property-removed
- ▲
  removed the required property write_iops_limit from the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-removed
Feb 10, 20260784c08f844512See the full diff
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property read_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_bw_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_delay_max to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/json)
  response-required-property-added
- ○
  added the required property write_iops_limit to the response with the 200 status (media type: application/vnd.ceph.api.v1.0+json)
  response-required-property-added

Full history