About Qumulo
Knowledge Base
Nexus
🔒
Send Slack Message
Open a Case
Toggle navigation
Qumulo Documentation Portal
Reading Mode
Edit on GitHub
Download PDF
Qumulo REST API Guide
Documentation Home
Qumulo REST API Guide Home
Contacting the Qumulo Care Team
Access Tokens (auth)
V1
auth/
access-tokens
v1
auth/
access-tokens/
{id}
v1
Active Directory (ad)
V1
ad/
cancel
v1
ad/
dismiss-error
v1
ad/
distinguished-names/
{dn}/
object
v1
ad/
gids/
{gid}/
sids
v1
ad/
join
v1
ad/
leave
v1
ad/
monitor
v1
ad/
reconfigure
v1
ad/
settings
v1
ad/
sids/
{sid}/
expanded-groups
v1
ad/
sids/
{sid}/
gid
v1
ad/
sids/
{sid}/
object
v1
ad/
sids/
{sid}/
uid
v1
ad/
sids/
{sid}/
username
v1
ad/
status
v1
ad/
uids/
{uid}/
sids
v1
ad/
usernames/
{username}/
objects
v1
ad/
usernames/
{username}/
sids
v1
Analytics (analytics)
V1
analytics/
activity/
current
v1
analytics/
capacity-history
v1
analytics/
capacity-history/
{timestamp}
v1
analytics/
time-series
v1
Audit Log (audit)
V1
audit/
cloudwatch/
config
v1
audit/
cloudwatch/
status
v1
audit/
syslog/
config
v1
audit/
syslog/
status
v1
Authentication (auth)
V1
auth/
auth-ids/
{id}/
related-identities
v1
auth/
clear-cache
v1
auth/
identities/
{id}/
attributes
v1
auth/
identity/
expand
v1
auth/
identity/
find
v1
auth/
kerberos-keytab
v1
auth/
kerberos-settings
v1
auth/
local-username/
{username}/
related-identities
v1
auth/
posix-gids/
{id}/
related-identities
v1
auth/
posix-uids/
{id}/
related-identities
v1
auth/
sids/
{id}/
related-identities
v1
auth/
user-defined-mappings
v1
Capacity Clamp (capacity)
V1
capacity/
clamp
v1
Cloud Data Fabric (portal)
V1
portal/
file-systems
v1
portal/
file-systems/
{id}
v1
portal/
files/
{file_id}/
evict
v1
portal/
hubs
v1
portal/
hubs/
{id}
v1
portal/
hubs/
{id}/
authorize
v1
portal/
spokes
v1
portal/
spokes/
eviction-settings
v1
portal/
spokes/
{id}
v1
portal/
spokes/
{id}/
propose
v1
Cloud Data Fabric (portal)
V2
preview
portal/
hubs
v2
preview
portal/
hubs/
{id}
v2
preview
portal/
hubs/
{id}/
accept
v2
preview
portal/
hubs/
{id}/
roots/
{dir}
v2
preview
portal/
spokes
v2
preview
portal/
spokes/
{id}
v2
preview
portal/
spokes/
{id}/
roots
v2
preview
portal/
spokes/
{id}/
roots/
{dir}
v2
preview
Cluster Creation (cluster)
V2
cluster/
create
v2
Cluster Creation (cluster)
V3
cluster/
calculate-supported-protection-info
v3
Cluster Creation (cluster)
V4
cluster/
object-backed/
create
v4
Cluster Creation (cluster)
V5
cluster/
object-backed/
create
v5
Cluster Data Protection (cluster)
V1
cluster/
object-backed/
protection/
fault-tolerance
v1
cluster/
protection/
restriper/
status
v1
cluster/
protection/
status
v1
Cluster Management (cluster)
V1
cluster/
calculate-node-add-capacity
v1
cluster/
node-replacement-plan
v1
cluster/
nodes
v1
cluster/
nodes/
chassis
v1
cluster/
nodes/
uid-lights
v1
cluster/
nodes/
{id}
v1
cluster/
nodes/
{id}/
chassis
v1
cluster/
nodes/
{id}/
identify
v1
cluster/
nodes/
{id}/
uid-light
v1
cluster/
restriper/
status
v1
Cluster Management (cluster)
V2
cluster/
nodes
v2
cluster/
nodes/
dry-run
v2
cluster/
object-backed/
nodes
v2
cluster/
object-backed/
nodes/
dry-run
v2
Cluster Settings (cluster)
V1
cluster/
settings
v1
cluster/
settings/
ssl
v1
Cluster Settings (cluster)
V2
cluster/
settings/
ssl/
ca-certificate
v2
cluster/
settings/
ssl/
certificate
v2
cluster/
settings/
ssl/
ciphers
v2
Cluster Slots (cluster)
V1
cluster/
slots
v1
cluster/
slots/
node/
{node_id}
v1
cluster/
slots/
{id}
v1
DNS Config Methods (dns)
V1
dns/
configs/
system
v1
DNS Methods (dns)
V1
dns/
clear-dns-cache
v1
dns/
lookup-override-config
v1
dns/
resolve
v1
dns/
resolve-ips-to-names
v1
dns/
resolve-names-to-ips
v1
Directory Quotas (files)
V1
files/
quotas
v1
files/
quotas/
status
v1
files/
quotas/
status/
{id}
v1
files/
quotas/
{id}
v1
Encryption at Rest (encryption)
V1
encryption/
rotate-keys
v1
encryption/
status
v1
Encryption at Rest (encryption)
V2
encryption/
external-kms/
keys/
create
v2
encryption/
key-store
v2
encryption/
key-store/
status
v2
encryption/
rotate-keys
v2
FTP Methods (ftp)
V0
ftp/
settings
v0
ftp/
status
v0
File System (file-system)
V1
file-system
v1
file-system/
security/
keys
v1
file-system/
security/
keys/
{key_ref}
v1
file-system/
security/
keys/
{key_ref}/
key-replacement-challenge
v1
file-system/
security/
keys/
{key_ref}/
replace
v1
file-system/
security/
keys/
{key_ref}/
usages
v1
file-system/
settings/
atime
v1
file-system/
settings/
notify
v1
file-system/
settings/
permissions
v1
Files (files)
V1
files/
locks/
nfs4/
byte-range
v1
files/
locks/
nlm/
byte-range
v1
files/
locks/
nlm/
byte-range/
waiters
v1
files/
locks/
smb/
byte-range
v1
files/
locks/
smb/
share-mode
v1
files/
resolve
v1
files/
{ref}
v1
files/
{ref}/
aggregates
v1
files/
{ref}/
copy-chunk
v1
files/
{ref}/
data
v1
files/
{ref}/
entries
v1
files/
{ref}/
entries/
{name}
v1
files/
{ref}/
file-lock
v1
files/
{ref}/
info/
acl
v1
files/
{ref}/
info/
acl/
explain-posix-mode
v1
files/
{ref}/
info/
acl/
explain-rights
v1
files/
{ref}/
info/
acl/
explain-set-mode
v1
files/
{ref}/
info/
attributes
v1
files/
{ref}/
locks/
nfs4/
byte-range
v1
files/
{ref}/
locks/
nlm/
byte-range
v1
files/
{ref}/
locks/
nlm/
byte-range/
waiters
v1
files/
{ref}/
locks/
smb/
byte-range
v1
files/
{ref}/
locks/
smb/
share-mode
v1
files/
{ref}/
notify
v1
files/
{ref}/
punch-hole
v1
files/
{ref}/
recursive-aggregates
v1
files/
{ref}/
sample
v1
files/
{ref}/
streams
v1
files/
{ref}/
streams/
{stream_id}
v1
files/
{ref}/
streams/
{stream_id}/
attributes
v1
files/
{ref}/
streams/
{stream_id}/
copy-chunk
v1
files/
{ref}/
streams/
{stream_id}/
data
v1
files/
{ref}/
streams/
{stream_id}/
punch-hole
v1
files/
{ref}/
streams/
{stream_id}/
rename
v1
files/
{ref}/
user-metadata
v1
files/
{ref}/
user-metadata/
{type}
v1
files/
{ref}/
user-metadata/
{type}/
{key}
v1
Files (files)
V2
files/
{ref}/
info/
acl
v2
Hardware Health Methods (health)
V1
health/
ssd-endurance
v1
Identity (identity)
V1
identity/
expand
v1
identity/
find
v1
LDAP Server (ldap)
V1
ldap/
login-name/
{login_name}/
gid-numbers
v1
ldap/
login-name/
{login_name}/
uid-numbers
v1
ldap/
status
v1
ldap/
uid-number/
{uid_number}/
login-name
v1
LDAP Server (ldap)
V2
ldap/
settings
v2
License Management (license)
V1
preview
license/
enforcement
v1
preview
license/
status
v1
preview
Local Group Methods (groups)
V1
groups
v1
groups/
{group_id}/
members
v1
groups/
{group_id}/
members/
{member_id}
v1
groups/
{id}
v1
Local User Methods (users)
V1
users
v1
users/
{id}
v1
users/
{id}/
groups
v1
users/
{id}/
setpassword
v1
Metrics (metrics)
V2
metrics/
endpoints/
default/
data
v2
Monitoring Configuration and Status (support)
V1
support/
settings
v1
support/
status
v1
support/
vpn-keys
v1
support/
vpn/
key/
certificate-signing-request
v1
support/
vpn/
key/
generate
v1
NFS Methods (nfs)
V2
nfs/
exports
v2
nfs/
exports/
{ref}
v2
nfs/
settings
v2
NFS Methods (nfs)
V3
preview
nfs/
exports
v3
preview
nfs/
exports/
{export_id}
v3
preview
NFS Multitenancy Methods (multitenancy)
V1
preview
multitenancy/
nfs/
global-settings
v1
preview
multitenancy/
nfs/
settings
v1
preview
multitenancy/
nfs/
settings/
{id}
v1
preview
Network Configuration (network)
V1
network/
floating-ip-allocation
v1
network/
settings
v1
network/
static-ip-allocation
v1
network/
status
v1
network/
status/
{id}
v1
Network Configuration (network)
V2
network/
connections
v2
network/
interfaces
v2
network/
interfaces/
{id}/
status
v2
network/
interfaces/
{interface_id}
v2
network/
interfaces/
{interface_id}/
networks
v2
network/
interfaces/
{interface_id}/
networks/
{network_id}
v2
network/
interfaces/
{interface_id}/
status/
{node_id}
v2
Network Configuration (network)
V3
preview
network
v3
preview
network/
backend-interfaces
v3
preview
network/
frontend-interfaces
v3
preview
network/
status
v3
preview
network/
status/
{node_id}
v3
preview
network/
validate
v3
preview
Node Management (node)
V1
node/
state
v1
Object Storage (object-storage)
V1
object-storage/
add-uris
v1
object-storage/
uris
v1
Replication (replication)
V2
replication/
source-relationships
v2
replication/
source-relationships/
reverse-target-relationship
v2
replication/
source-relationships/
status
v2
replication/
source-relationships/
{id}
v2
replication/
source-relationships/
{id}/
abort-replication
v2
replication/
source-relationships/
{id}/
dismiss-error
v2
replication/
source-relationships/
{id}/
queued-snapshots
v2
replication/
source-relationships/
{id}/
replicate
v2
replication/
source-relationships/
{id}/
status
v2
replication/
source-relationships/
{relationship_id}/
queued-snapshots/
{snapshot_id}
v2
replication/
target-relationships/
status
v2
replication/
target-relationships/
{id}/
authorize
v2
replication/
target-relationships/
{id}/
delete
v2
replication/
target-relationships/
{id}/
dismiss-error
v2
replication/
target-relationships/
{id}/
lock
v2
replication/
target-relationships/
{id}/
make-writable
v2
replication/
target-relationships/
{id}/
reconnect
v2
replication/
target-relationships/
{id}/
status
v2
Replication (replication)
V3
replication/
object-relationships
v3
replication/
object-relationships/
status
v3
replication/
object-relationships/
{id}
v3
replication/
object-relationships/
{id}/
abort-replication
v3
replication/
object-relationships/
{id}/
replicate
v3
replication/
object-relationships/
{id}/
status
v3
Roles (auth)
V1
auth/
privileges
v1
auth/
roles
v1
auth/
roles/
{role_name}
v1
auth/
roles/
{role_name}/
members
v1
auth/
roles/
{role_name}/
members/
{member_id}
v1
S3 Server Methods (s3)
V1
s3/
access-keys
v1
s3/
access-keys/
{id}
v1
s3/
buckets
v1
s3/
buckets/
{name}
v1
s3/
buckets/
{name}/
policy
v1
s3/
buckets/
{name}/
policy/
explain-access
v1
s3/
buckets/
{name}/
uploads
v1
s3/
buckets/
{name}/
uploads/
{id}
v1
s3/
settings
v1
SAML Configuration (saml)
V1
saml/
settings
v1
SMB File Administration (smb)
V1
smb/
files
v1
smb/
files/
close
v1
SMB Multitenancy Methods (multitenancy)
V1
preview
multitenancy/
smb/
global-settings
v1
preview
multitenancy/
smb/
settings
v1
preview
multitenancy/
smb/
settings/
{id}
v1
preview
SMB Server Settings (smb)
V1
smb/
settings
v1
SMB Session Administration (smb)
V1
smb/
sessions
v1
smb/
sessions/
close
v1
SMB Shares Methods (smb)
V1
smb/
shares
v1
smb/
shares/
{id}
v1
SMB Shares Methods (smb)
V2
smb/
shares
v2
smb/
shares/
{ref}
v2
SMB Shares Methods (smb)
V3
preview
smb/
shares
v3
preview
smb/
shares/
{share_id}
v3
preview
Session Management (session)
V1
session/
change-password
v1
session/
login
v1
session/
retrieve-saml-login
v1
session/
roles
v1
session/
start-saml-login
v1
session/
who-am-i
v1
Shutdown (shutdown)
V1
shutdown/
container-restart/
{node_id}
v1
shutdown/
halt
v1
shutdown/
halt/
{node_id}
v1
shutdown/
reboot/
pause
v1
shutdown/
reboot/
resume
v1
shutdown/
reboot/
start
v1
shutdown/
reboot/
status
v1
shutdown/
reboot/
{node_id}
v1
Snapshots (snapshots)
V1
snapshots
v1
snapshots/
calculate-used-capacity
v1
snapshots/
capacity-used-per-snapshot
v1
snapshots/
capacity-used-per-snapshot/
{id}
v1
snapshots/
policies
v1
snapshots/
policies/
status
v1
snapshots/
policies/
status/
{id}
v1
snapshots/
policies/
{id}
v1
snapshots/
total-used-capacity
v1
snapshots/
{id}
v1
Snapshots (snapshots)
V2
snapshots
v2
snapshots/
policies
v2
snapshots/
policies/
status
v2
snapshots/
policies/
status/
{id}
v2
snapshots/
policies/
{id}
v2
snapshots/
status
v2
snapshots/
status/
{id}
v2
snapshots/
{id}
v2
snapshots/
{newer_id}/
changes-since/
{older_id}
v2
snapshots/
{newer_id}/
changes-since/
{older_id}/
files/
{ref}
v2
Snapshots (snapshots)
V3
snapshots
v3
snapshots/
policies
v3
snapshots/
policies/
status
v3
snapshots/
policies/
status/
{id}
v3
snapshots/
policies/
{id}
v3
snapshots/
status
v3
snapshots/
status/
{id}
v3
snapshots/
{id}
v3
snapshots/
{id}/
lock
v3
snapshots/
{id}/
unlock
v3
snapshots/
{id}/
unlock-challenge
v3
Snapshots (snapshots)
V4
snapshots/
status
v4
Tenant Configuration (multitenancy)
V1
preview
multitenancy/
tenants
v1
preview
multitenancy/
tenants/
{tenant_id}
v1
preview
Time Configuration Methods (time)
V1
time/
settings
v1
time/
status
v1
time/
timezones
v1
Tree Delete (tree-delete)
V1
tree-delete/
jobs
v1
tree-delete/
jobs/
restart/
{id}
v1
tree-delete/
jobs/
{id}
v1
Unconfigured Node Management (node)
V1
node/
state
v1
Unconfigured Nodes (unconfigured)
V1
unconfigured/
nodes
v1
Unconfigured Nodes Discovery (unconfigured)
V1
unconfigured/
nodes
v1
Unconfigured Version (version)
V1
version
v1
Upgrade (upgrade)
V2
upgrade/
blocked
v2
upgrade/
commit
v2
upgrade/
prepare
v2
upgrade/
status
v2
upgrade/
verify-image
v2
Upgrade (upgrade)
V3
upgrade/
status
v3
Version (version)
V1
version
v1
Web UI Settings (web-ui)
V1
web-ui/
settings
v1
Home
›
Qumulo REST API Guide
›
Snapshots V3 (snapshots)
Snapshots V3 (snapshots)
Table of Contents
snapshots
snapshots/policies
snapshots/policies/status
snapshots/policies/status/{id}
snapshots/policies/{id}
snapshots/status
snapshots/status/{id}
snapshots/{id}
snapshots/{id}/lock
snapshots/{id}/unlock
snapshots/{id}/unlock-challenge
