Qumulo REST API Guide

Table of Contents

• Access Tokens V1 (auth)
  • auth/access-tokens
  • auth/access-tokens/{id}

• Active Directory V1 (ad)
  • ad/cancel
  • ad/dismiss-error
  • ad/distinguished-names/{dn}/object
  • ad/gids/{gid}/sids
  • ad/join
  • ad/leave
  • ad/monitor
  • ad/reconfigure
  • ad/settings
  • ad/sids/{sid}/expanded-groups
  • ad/sids/{sid}/gid
  • ad/sids/{sid}/object
  • ad/sids/{sid}/uid
  • ad/sids/{sid}/username
  • ad/status
  • ad/uids/{uid}/sids
  • ad/usernames/{username}/objects
  • ad/usernames/{username}/sids

• Analytics V1 (analytics)
  • analytics/activity/current
  • analytics/capacity-history
  • analytics/capacity-history/{timestamp}
  • analytics/time-series

• Audit Log V1 (audit)
  • audit/cloudwatch/config
  • audit/cloudwatch/status
  • audit/syslog/config
  • audit/syslog/status

• Authentication V1 (auth)
  • auth/auth-ids/{id}/related-identitiesdeprecated
  • auth/clear-cache
  • auth/identities/{id}/attributes
  • auth/identity/expanddeprecated
  • auth/identity/finddeprecated
  • auth/kerberos-keytab
  • auth/kerberos-settings
  • auth/local-username/{username}/related-identitiesdeprecated
  • auth/posix-gids/{id}/related-identitiesdeprecated
  • auth/posix-uids/{id}/related-identitiesdeprecated
  • auth/sids/{id}/related-identitiesdeprecated
  • auth/user-defined-mappings

• Authoritative DNS Methods V1 (authoritative-dns)
  • authoritative-dns/settings

• Capacity Clamp V1 (capacity)
  • capacity/clamp

• Cloud Data Fabric V1 (portal)
  • portal/file-systems
  • portal/file-systems/{id}
  • portal/files/{file_id}/evict
  • portal/hubsdeprecated
  • portal/hubs/{id}deprecated
  • portal/hubs/{id}/authorizedeprecated
  • portal/pingpreview
  • portal/spokesdeprecated
  • portal/spokes/eviction-settings
  • portal/spokes/{id}deprecated
  • portal/spokes/{id}/proposedeprecated

• Cloud Data Fabric V2 (portal)
  • portal/hubs
  • portal/hubs/{id}
  • portal/hubs/{id}/accept
  • portal/hubs/{id}/roots/{dir}
  • portal/spokes
  • portal/spokes/{id}
  • portal/spokes/{id}/roots
  • portal/spokes/{id}/roots/{dir}

• Cluster Creation V2 (cluster)
  • cluster/create
  • cluster/data-core/create
  • cluster/unprotected-edge/create

• Cluster Creation V3 (cluster)
  • cluster/calculate-supported-protection-info

• Cluster Creation V4 (cluster)
  • cluster/object-backed/create

• Cluster Creation V5 (cluster)
  • cluster/object-backed/create
  • cluster/object-backed/create-stratus

• Cluster Data Protection V1 (cluster)
  • cluster/object-backed/protection/fault-tolerance
  • cluster/protection/restriper/status
  • cluster/protection/status

• Cluster Management V1 (cluster)
  • cluster/calculate-node-add-capacitydeprecated
  • cluster/node-replacement-plan
  • cluster/nodesdeprecated
  • cluster/nodes/chassisdeprecated
  • cluster/nodes/uid-lights
  • cluster/nodes/{id}
  • cluster/nodes/{id}/chassisdeprecated
  • cluster/nodes/{id}/identify
  • cluster/nodes/{id}/uid-light
  • cluster/restriper/statusdeprecated

• Cluster Management V2 (cluster)
  • cluster/nodes
  • cluster/nodes/dry-run
  • cluster/object-backed/nodes
  • cluster/object-backed/nodes/dry-run

• Cluster Settings V1 (cluster)
  • cluster/settings
  • cluster/settings/ssl

• Cluster Settings V2 (cluster)
  • cluster/settings/ssl/ca-certificate
  • cluster/settings/ssl/certificate
  • cluster/settings/ssl/ciphers

• Cluster Slots V1 (cluster)
  • cluster/slots
  • cluster/slots/node/{node_id}
  • cluster/slots/{id}

• DNS Config Methods V1 (dns)
  • dns/configs/system

• DNS Methods V1 (dns)
  • dns/clear-dns-cache
  • dns/lookup-override-config
  • dns/resolvedeprecated
  • dns/resolve-ips-to-names
  • dns/resolve-names-to-ips

• Directory Quotas V1 (files)
  • files/quotas
  • files/quotas/status
  • files/quotas/status/{id}
  • files/quotas/{id}

• Encryption at Rest V1 (encryption)
  • encryption/rotate-keysdeprecated
  • encryption/statusdeprecated

• Encryption at Rest V2 (encryption)
  • encryption/external-kms/keys/create
  • encryption/key-store
  • encryption/key-store/status
  • encryption/rotate-keys

• FTP Methods V0 (ftp)
  • ftp/settings
  • ftp/status

• File System V1 (file-system)
  • file-system
  • file-system/security/keys
  • file-system/security/keys/{key_ref}
  • file-system/security/keys/{key_ref}/key-replacement-challenge
  • file-system/security/keys/{key_ref}/replace
  • file-system/security/keys/{key_ref}/usages
  • file-system/settings/atime
  • file-system/settings/notify
  • file-system/settings/permissions

• Files V1 (files)
  • files/locks/nfs4/byte-range
  • files/locks/nlm/byte-range
  • files/locks/nlm/byte-range/waiters
  • files/locks/smb/byte-range
  • files/locks/smb/share-mode
  • files/resolve
  • files/{ref}
  • files/{ref}/aggregates
  • files/{ref}/copy-chunk
  • files/{ref}/data
  • files/{ref}/entries
  • files/{ref}/entries/{name}
  • files/{ref}/file-lock
  • files/{ref}/info/acl
  • files/{ref}/info/acl/explain-posix-mode
  • files/{ref}/info/acl/explain-rights
  • files/{ref}/info/acl/explain-set-mode
  • files/{ref}/info/attributes
  • files/{ref}/locks/nfs4/byte-range
  • files/{ref}/locks/nlm/byte-range
  • files/{ref}/locks/nlm/byte-range/waiters
  • files/{ref}/locks/smb/byte-range
  • files/{ref}/locks/smb/share-mode
  • files/{ref}/notify
  • files/{ref}/punch-hole
  • files/{ref}/recursive-aggregates
  • files/{ref}/sample
  • files/{ref}/streams
  • files/{ref}/streams/{stream_id}
  • files/{ref}/streams/{stream_id}/attributes
  • files/{ref}/streams/{stream_id}/copy-chunk
  • files/{ref}/streams/{stream_id}/data
  • files/{ref}/streams/{stream_id}/punch-hole
  • files/{ref}/streams/{stream_id}/rename
  • files/{ref}/user-metadata
  • files/{ref}/user-metadata/{type}
  • files/{ref}/user-metadata/{type}/{key}

• Files V2 (files)
  • files/{ref}/info/acl

• Hardware Health Methods V1 (health)
  • health/ssd-endurance

• Identity V1 (identity)
  • identity/expand
  • identity/find

• LDAP Server V1 (ldap)
  • ldap/login-name/{login_name}/gid-numbers
  • ldap/login-name/{login_name}/uid-numbers
  • ldap/status
  • ldap/uid-number/{uid_number}/login-name

• LDAP Server V2 (ldap)
  • ldap/settings

• License Management V1 (license)
  • license/enforcementpreview
  • license/statuspreview

• Local Group Methods V1 (groups)
  • groups
  • groups/{group_id}/members
  • groups/{group_id}/members/{member_id}
  • groups/{id}

• Local User Methods V1 (users)
  • users
  • users/{id}
  • users/{id}/groups
  • users/{id}/setpassword

• Metrics V2 (metrics)
  • metrics/endpoints/default/data

• Monitoring Configuration and Status V1 (support)
  • support/settings
  • support/status
  • support/vpn-keys
  • support/vpn/key/certificate-signing-request
  • support/vpn/key/generate

• NFS Methods V2 (nfs)
  • nfs/exports
  • nfs/exports/{ref}
  • nfs/settings

• NFS Methods V3 (nfs)
  • nfs/exportspreview
  • nfs/exports/{export_id}preview

• NFS Multitenancy Methods V1 (multitenancy)
  • multitenancy/nfs/global-settingspreview
  • multitenancy/nfs/settingspreview
  • multitenancy/nfs/settings/{id}preview

• Network Configuration V1 (network)
  • network/floating-ip-allocation
  • network/settingsdeprecated
  • network/static-ip-allocation
  • network/statusdeprecated
  • network/status/{id}deprecated

• Network Configuration V2 (network)
  • network/connections
  • network/interfaces
  • network/interfaces/{id}/status
  • network/interfaces/{interface_id}
  • network/interfaces/{interface_id}/networks
  • network/interfaces/{interface_id}/networks/{network_id}
  • network/interfaces/{interface_id}/status/{node_id}

• Network Configuration V3 (network)
  • network
  • network/backend-interfaces
  • network/frontend-interfaces
  • network/status
  • network/status/{node_id}
  • network/validate

• Nexus Configuration V1 (nexus)
  • nexus/connection
  • nexus/registration
  • nexus/registration/rotate

• Node Management V1 (node)
  • node/state

• Object Storage V1 (object-storage)
  • object-storage/add-uris
  • object-storage/external-credentials-source
  • object-storage/uris

• Object Storage V2 (object-storage)
  • object-storage/add-uris

• Replication V2 (replication)
  • replication/source-relationships
  • replication/source-relationships/reverse-target-relationship
  • replication/source-relationships/status
  • replication/source-relationships/{id}
  • replication/source-relationships/{id}/abort-replication
  • replication/source-relationships/{id}/dismiss-error
  • replication/source-relationships/{id}/queued-snapshots
  • replication/source-relationships/{id}/replicate
  • replication/source-relationships/{id}/status
  • replication/source-relationships/{relationship_id}/queued-snapshots/{snapshot_id}
  • replication/target-relationships/status
  • replication/target-relationships/{id}/authorize
  • replication/target-relationships/{id}/delete
  • replication/target-relationships/{id}/dismiss-error
  • replication/target-relationships/{id}/lock
  • replication/target-relationships/{id}/make-writable
  • replication/target-relationships/{id}/reconnect
  • replication/target-relationships/{id}/status

• Replication V3 (replication)
  • replication/object-relationships
  • replication/object-relationships/status
  • replication/object-relationships/{id}
  • replication/object-relationships/{id}/abort-replication
  • replication/object-relationships/{id}/replicate
  • replication/object-relationships/{id}/status

• Roles V1 (auth)
  • auth/privileges
  • auth/roles
  • auth/roles/{role_name}
  • auth/roles/{role_name}/members
  • auth/roles/{role_name}/members/{member_id}

• S3 Server Methods V1 (s3)
  • s3/access-keys
  • s3/access-keys/{id}
  • s3/buckets
  • s3/buckets/{name}
  • s3/buckets/{name}/policy
  • s3/buckets/{name}/policy/explain-access
  • s3/buckets/{name}/uploads
  • s3/buckets/{name}/uploads/{id}
  • s3/settings

• SAML Configuration V1 (saml)
  • saml/settings

• SMB File Administration V1 (smb)
  • smb/files
  • smb/files/close

• SMB Multitenancy Methods V1 (multitenancy)
  • multitenancy/smb/global-settingspreview
  • multitenancy/smb/settingspreview
  • multitenancy/smb/settings/{id}preview

• SMB Server Settings V1 (smb)
  • smb/settings

• SMB Session Administration V1 (smb)
  • smb/sessions
  • smb/sessions/close

• SMB Shares Methods V1 (smb)
  • smb/sharesdeprecated
  • smb/shares/{id}deprecated

• SMB Shares Methods V2 (smb)
  • smb/shares
  • smb/shares/{ref}

• SMB Shares Methods V3 (smb)
  • smb/sharespreview
  • smb/shares/{share_id}preview

• Session Management V1 (session)
  • session/change-password
  • session/login
  • session/retrieve-saml-login
  • session/roles
  • session/start-saml-login
  • session/who-am-i

• Shutdown V1 (shutdown)
  • shutdown/container-restart/{node_id}
  • shutdown/halt
  • shutdown/halt/{node_id}
  • shutdown/reboot/pause
  • shutdown/reboot/resume
  • shutdown/reboot/start
  • shutdown/reboot/status
  • shutdown/reboot/{node_id}

• Snapshots V1 (snapshots)
  • snapshotsdeprecated
  • snapshots/calculate-used-capacity
  • snapshots/capacity-used-per-snapshot
  • snapshots/capacity-used-per-snapshot/{id}
  • snapshots/policiesdeprecated
  • snapshots/policies/statusdeprecated
  • snapshots/policies/status/{id}deprecated
  • snapshots/policies/{id}deprecated
  • snapshots/total-used-capacity
  • snapshots/{id}deprecated

• Snapshots V2 (snapshots)
  • snapshotsdeprecated
  • snapshots/policiesdeprecated
  • snapshots/policies/statusdeprecated
  • snapshots/policies/status/{id}deprecated
  • snapshots/policies/{id}deprecated
  • snapshots/statusdeprecated
  • snapshots/status/{id}deprecated
  • snapshots/{id}deprecated
  • snapshots/{newer_id}/changes-since/{older_id}
  • snapshots/{newer_id}/changes-since/{older_id}/files/{ref}

• Snapshots V3 (snapshots)
  • snapshots
  • snapshots/policies
  • snapshots/policies/status
  • snapshots/policies/status/{id}
  • snapshots/policies/{id}
  • snapshots/statusdeprecated
  • snapshots/status/{id}
  • snapshots/{id}
  • snapshots/{id}/lock
  • snapshots/{id}/unlock
  • snapshots/{id}/unlock-challenge

• Snapshots V4 (snapshots)
  • snapshots/status

• Tenant Configuration V1 (multitenancy)
  • multitenancy/tenantspreview
  • multitenancy/tenants/{tenant_id}preview

• Time Configuration Methods V1 (time)
  • time/settings
  • time/status
  • time/timezones

• Tree Delete V1 (tree-delete)
  • tree-delete/jobs
  • tree-delete/jobs/restart/{id}
  • tree-delete/jobs/{id}

• Unconfigured Node Management V1 (node)
  • node/state

• Unconfigured Nodes V1 (unconfigured)
  • unconfigured/nodes

• Unconfigured Nodes Discovery V1 (unconfigured)
  • unconfigured/nodes

• Unconfigured Version V1 (version)
  • version

• Upgrade V2 (upgrade)
  • upgrade/blocked
  • upgrade/commit
  • upgrade/prepare
  • upgrade/statusdeprecated
  • upgrade/verify-image

• Upgrade V3 (upgrade)
  • upgrade/status

• Version V1 (version)
  • version

• Web UI Settings V1 (web-ui)
  • web-ui/settingsdeprecated