About Qumulo Knowledge Base Nexus

Send Slack Message Open a Case

Qumulo Documentation

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)
- auth/access-tokens
- auth/access-tokens/{id}
Active Directory (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 (analytics)
- analytics/activity/current
- analytics/capacity-history
- analytics/capacity-history/{timestamp}
- analytics/time-series
Audit Log (audit)
- audit/cloudwatch/config
- audit/cloudwatch/status
- audit/syslog/config
- audit/syslog/status
Authentication (auth)
- auth/auth-ids/{id}/related-identities
- auth/clear-cache
- auth/identities/{id}/attributes
- auth/identity/expand
- auth/identity/find
- auth/kerberos-keytab
- auth/kerberos-settings
- auth/local-username/{username}/related-identities
- auth/posix-gids/{id}/related-identities
- auth/posix-uids/{id}/related-identities
- auth/sids/{id}/related-identities
- auth/user-defined-mappings
Capacity Clamp (capacity)
- capacity/clamp
Cluster Creation (cluster)
- v3 cluster/calculate-supported-protection-info
- v2 cluster/create
- v4 cluster/object-backed/create
Cluster Data Protection (cluster)
- cluster/protection/restriper/status
- cluster/protection/status
Cluster Management (cluster)
- cluster/calculate-node-add-capacity
- cluster/node-replacement-plan
- cluster/nodes
- v2 cluster/nodes
- cluster/nodes/chassis
- v2 cluster/nodes/dry-run
- cluster/nodes/uid-lights
- cluster/nodes/{id}
- cluster/nodes/{id}/chassis
- cluster/nodes/{id}/identify
- cluster/nodes/{id}/uid-light
- v2 cluster/object-backed/nodes
- v2 cluster/object-backed/nodes/dry-run
- cluster/restriper/status
Cluster Settings (cluster)
- cluster/settings
- cluster/settings/ssl
- v2 cluster/settings/ssl/ca-certificate
- v2 cluster/settings/ssl/certificate
- v2 cluster/settings/ssl/ciphers
Cluster Slots (cluster)
- cluster/slots
- cluster/slots/{id}
Unconfigured Node Management (node)
- node/state
Configured Node Management (node)
- node/state
DNS Config Methods (dns)
- dns/configs/system
DNS Methods (dns)
- dns/clear-dns-cache
- dns/lookup-override-config
- dns/resolve
- dns/resolve-ips-to-names
- dns/resolve-names-to-ips
Directory Quotas (files)
- files/quotas
- files/quotas/status
- files/quotas/status/{id}
- files/quotas/{id}
Encryption at Rest (encryption)
- encryption/rotate-keys
- encryption/status
Encryption at Rest (encryption) V2
- v2 encryption/external-kms/keys/create
- v2 encryption/key-store
- v2 encryption/key-store/status
- v2 encryption/rotate-keys
FTP Methods (ftp)
- ftp/settings
- ftp/status
File System (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 (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}/file-lock
- files/{ref}/info/acl
- v2 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}
Global Namespace (portal)
- portal/hubs
- portal/hubs/{id}
- portal/hubs/{id}/authorize
- portal/spokes
- portal/spokes/eviction-settings
- portal/spokes/{id}
- portal/spokes/{id}/evict-data
- portal/spokes/{id}/evict-link
- portal/spokes/{id}/evict-tree
- portal/spokes/{id}/propose
Identity (identity)
- identity/expand
- identity/find
LDAP Server (ldap)
- ldap/login-name/{login_name}/gid-numbers
- ldap/login-name/{login_name}/uid-numbers
- v2 ldap/settings
- ldap/status
- ldap/uid-number/{uid_number}/login-name
License Management (license)
- license/enforcement
- license/status
Local Group Methods (groups)
- groups
- groups/{group_id}/members
- groups/{group_id}/members/{member_id}
- groups/{id}
Local User Methods (users)
- users
- users/{id}
- users/{id}/groups
- users/{id}/setpassword
Metrics (metrics)
- v2 metrics/endpoints/default/data
Monitoring Configuration and Status (support)
- support/settings
- support/status
- support/vpn-keys
- support/vpn/key/certificate-signing-request
- support/vpn/key/generate
NFS Methods (nfs)
- v3 nfs/exports
- v3 nfs/exports/{export_id}
NFS Methods (nfs) V2
- v2 nfs/exports
- v2 nfs/exports/{ref}
- v2 nfs/settings
NFS Multitenancy Methods (multitenancy)
- multitenancy/nfs/global-settings
- multitenancy/nfs/settings
- multitenancy/nfs/settings/{id}
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}
Network Configuration (network) V1
- network/floating-ip-allocation
- network/settings
- network/static-ip-allocation
- network/status
- network/status/{id}
Object Storage (object-storage)
- object-storage/add-uris
- object-storage/uris
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
- 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
Roles (auth)
- auth/privileges
- auth/roles
- auth/roles/{role_name}
- auth/roles/{role_name}/members
- auth/roles/{role_name}/members/{member_id}
S3 Server Methods (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 (saml)
- saml/settings
SMB File Administration (smb)
- smb/files
- smb/files/close
SMB Multitenancy Methods (multitenancy)
- multitenancy/smb/global-settings
- multitenancy/smb/settings
- multitenancy/smb/settings/{id}
SMB Server Settings (smb)
- smb/settings
SMB Session Administration (smb)
- smb/sessions
- smb/sessions/close
SMB Shares Methods (smb)
- v3 smb/shares
- v3 smb/shares/{share_id}
SMB Shares Methods (smb) V1
- smb/shares
- smb/shares/{id}
SMB Shares Methods (smb) V2
- v2 smb/shares
- v2 smb/shares/{ref}
Session Management (session)
- session/change-password
- session/login
- session/retrieve-saml-login
- session/roles
- session/start-saml-login
- session/who-am-i
Shutdown (shutdown)
- shutdown/halt
- shutdown/reboot/pause
- shutdown/reboot/resume
- shutdown/reboot/start
- shutdown/reboot/status
Snapshots (snapshots)
- snapshots
- v2 snapshots
- v3 snapshots
- snapshots/calculate-used-capacity
- snapshots/capacity-used-per-snapshot
- snapshots/capacity-used-per-snapshot/{id}
- snapshots/policies
- v2 snapshots/policies
- v3 snapshots/policies
- snapshots/policies/status
- v2 snapshots/policies/status
- v3 snapshots/policies/status
- snapshots/policies/status/{id}
- v2 snapshots/policies/status/{id}
- v3 snapshots/policies/status/{id}
- snapshots/policies/{id}
- v2 snapshots/policies/{id}
- v3 snapshots/policies/{id}
- v2 snapshots/status
- v3 snapshots/status
- v4 snapshots/status
- v2 snapshots/status/{id}
- v3 snapshots/status/{id}
- snapshots/total-used-capacity
- snapshots/{id}
- v2 snapshots/{id}
- v3 snapshots/{id}
- v3 snapshots/{id}/lock
- v3 snapshots/{id}/unlock
- v3 snapshots/{id}/unlock-challenge
- v2 snapshots/{newer_id}/changes-since/{older_id}
- v2 snapshots/{newer_id}/changes-since/{older_id}/files/{ref}
Tenant Configuration (multitenancy)
- multitenancy/tenants
- multitenancy/tenants/{tenant_id}
Time Configuration Methods (time)
- time/settings
- time/status
- time/timezones
Tree Delete (tree-delete)
- tree-delete/jobs
- tree-delete/jobs/restart/{id}
- tree-delete/jobs/{id}
Unconfigured Nodes (unconfigured)
- unconfigured/nodes
Unconfigured Nodes Discovery (unconfigured)
- unconfigured/nodes
Version (version)
- version
Unconfigured Version (version)
- version
Upgrade (upgrade)
- v2 upgrade/blocked
- v2 upgrade/commit
- v2 upgrade/prepare
- v2 upgrade/status
- v3 upgrade/status
- v2 upgrade/verify-image
Web UI Settings (web-ui)
- web-ui/settings

Home › Qumulo REST API Guide › Authentication (auth)

Authentication (auth)

Table of Contents

auth/auth-ids/{id}/related-identities
auth/clear-cache
auth/identities/{id}/attributes
auth/identity/expand
auth/identity/find
auth/kerberos-keytab
auth/kerberos-settings
auth/local-username/{username}/related-identities
auth/posix-gids/{id}/related-identities
auth/posix-uids/{id}/related-identities
auth/sids/{id}/related-identities
auth/user-defined-mappings

Copyright © 2021–2024 Qumulo, Inc.
Privacy Policy ❘ Cookie Policy ❘ Terms Hub

We use cookies to improve your user experience and remember your preferences on this website. If you continue to use this website, we will assume that you accept and understand our Privacy Policy, Cookie Policy, and Terms Hub.

Accept