Find out API endpoints

Isilon API Endpoints

GET https://172.16.227.100:8080/platform to list API

Welcome to the OneFS RESTful API for cluster configuration.

From here you can programatically configure, manage, and monitor your cluster using
HTTP calls to the interfaces listed below.

For more information on any specific endpoint, you can send a GET request to that
endpoint with the query arg "describe" appended, for example:

https://<your-cluster-or-node>:8080/platform/<endpoint>?describe

Endpoints:

/3/antivirus/policies
/3/antivirus/policies/<NAME>
/3/antivirus/quarantine/<PATH+>
/3/antivirus/reports/scans
/3/antivirus/reports/scans/<ID>
/3/antivirus/reports/threats
/3/antivirus/reports/threats/<ID>
/3/antivirus/scan
/3/antivirus/servers
/3/antivirus/servers/<ID+>
/3/antivirus/settings
/4/audit/progress
/4/audit/progress/global
/1/audit/settings
/3/audit/settings
/3/audit/settings/global
/1/audit/topics
/1/audit/topics/<NAME>
/1/auth/access/<USER>
/4/auth/cache
/1/auth/groups
/1/auth/groups/<GROUP>
/1/auth/groups/<GROUP>/members
/1/auth/groups/<GROUP>/members/<MEMBER>
/1/auth/id
/4/auth/ldap-templates
/4/auth/ldap-templates/<ID>
/3/auth/log-level
/3/auth/mapping/dump
/1/auth/mapping/identities
/1/auth/mapping/identities/<SOURCE>
/3/auth/mapping/import
/1/auth/mapping/users/lookup
/1/auth/mapping/users/rules
/1/auth/netgroups/<NETGROUP>
/1/auth/privileges
/1/auth/providers/ads
/3/auth/providers/ads
/1/auth/providers/ads/<ID>
/3/auth/providers/ads/<ID>
/1/auth/providers/ads/<ID>/controllers
/3/auth/providers/ads/<ID>/controllers
/1/auth/providers/ads/<ID>/domains
/3/auth/providers/ads/<ID>/domains
/1/auth/providers/ads/<ID>/domains/<ADS-DOMAIN>
/3/auth/providers/ads/<ID>/domains/<ADS-DOMAIN>
/1/auth/providers/ads/<ID>/search
/1/auth/providers/file
/1/auth/providers/file/<ID>
/1/auth/providers/krb5
/3/auth/providers/krb5
/1/auth/providers/krb5/<ID>
/3/auth/providers/krb5/<ID>
/1/auth/providers/ldap
/3/auth/providers/ldap
/4/auth/providers/ldap
/1/auth/providers/ldap/<ID>
/3/auth/providers/ldap/<ID>
/4/auth/providers/ldap/<ID>
/1/auth/providers/local
/1/auth/providers/local/<ID>
/1/auth/providers/nis
/3/auth/providers/nis
/1/auth/providers/nis/<ID>
/3/auth/providers/nis/<ID>
/1/auth/providers/summary
/3/auth/providers/summary
/3/auth/refresh
/1/auth/roles
/1/auth/roles/<ROLE>
/1/auth/roles/<ROLE>/members
/1/auth/roles/<ROLE>/members/<MEMBER>
/1/auth/roles/<ROLE>/privileges
/1/auth/roles/<ROLE>/privileges/<PRIVILEGE>
/3/auth/settings/acls
/1/auth/settings/global
/1/auth/settings/krb5/defaults
/1/auth/settings/krb5/domains
/1/auth/settings/krb5/domains/<DOMAIN>
/1/auth/settings/krb5/realms
/1/auth/settings/krb5/realms/<REALM>
/1/auth/settings/mapping
/1/auth/shells
/1/auth/users
/1/auth/users/<USER>
/3/auth/users/<USER>/change-password
/1/auth/users/<USER>/change_password
/3/auth/users/<USER>/member-of
/3/auth/users/<USER>/member-of/<MEMBER_OF>
/1/auth/users/<USER>/member_of
/1/auth/users/<USER>/member_of/<MEMBER_OF>
/1/auth/wellknowns
/1/auth/wellknowns/<WELLKNOWN>
/4/certificate/server
/4/certificate/server/<ID>
/3/cloud/access
/3/cloud/access/<GUID>
/3/cloud/accounts
/4/cloud/accounts
/3/cloud/accounts/<ACCOUNT>
/4/cloud/accounts/<ACCOUNT>
/3/cloud/jobs
/3/cloud/jobs-files/<JOB>
/3/cloud/jobs/<JOB>
/3/cloud/pools
/3/cloud/pools/<POOL>
/4/cloud/proxies
/4/cloud/proxies/<PROXY>
/3/cloud/settings
/3/cloud/settings/encryption-key
/3/cloud/settings/reporting-eula
/3/cluster/add-node
/1/cluster/config
/3/cluster/config
/3/cluster/diagnostics/gather
/3/cluster/diagnostics/gather/settings
/3/cluster/diagnostics/gather/start
/3/cluster/diagnostics/gather/status
/3/cluster/diagnostics/gather/stop
/3/cluster/diagnostics/netlogger
/3/cluster/diagnostics/netlogger/settings
/3/cluster/diagnostics/netlogger/start
/3/cluster/diagnostics/netlogger/status
/3/cluster/diagnostics/netlogger/stop
/1/cluster/email
/3/cluster/email/default-template
/1/cluster/external-ips
/2/cluster/external-ips
/1/cluster/identity
/3/cluster/identity
/5/cluster/identity
/3/cluster/nodes
/5/cluster/nodes
/3/cluster/nodes-available
/3/cluster/nodes/<LNN>
/5/cluster/nodes/<LNN>
/5/cluster/nodes/<LNN>/driveconfig
/3/cluster/nodes/<LNN>/drives
/5/cluster/nodes/<LNN>/drives
/3/cluster/nodes/<LNN>/drives-purposelist
/3/cluster/nodes/<LNN>/drives/<DRIVEID>
/5/cluster/nodes/<LNN>/drives/<DRIVEID>
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/add
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/firmware
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/firmware/update
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/format
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/purpose
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/smartfail
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/stopfail
/3/cluster/nodes/<LNN>/drives/<DRIVEID>/suspend
/3/cluster/nodes/<LNN>/hardware
/5/cluster/nodes/<LNN>/hardware
/3/cluster/nodes/<LNN>/hardware-fast
/3/cluster/nodes/<LNN>/partitions
/3/cluster/nodes/<LNN>/reboot
/5/cluster/nodes/<LNN>/reboot
/3/cluster/nodes/<LNN>/sensors
/3/cluster/nodes/<LNN>/shutdown
/5/cluster/nodes/<LNN>/shutdown
/5/cluster/nodes/<LNN>/sleds
/5/cluster/nodes/<LNN>/sleds/<SLEDID>
/3/cluster/nodes/<LNN>/state
/3/cluster/nodes/<LNN>/state/readonly
/3/cluster/nodes/<LNN>/state/servicelight
/3/cluster/nodes/<LNN>/state/smartfail
/3/cluster/nodes/<LNN>/status
/3/cluster/nodes/<LNN>/status/batterystatus
/1/cluster/owner
/1/cluster/statfs
/1/cluster/time
/3/cluster/time
/3/cluster/timezone
/3/cluster/timezone/regions/<REGION*>
/3/cluster/timezone/settings
/3/cluster/version
/1/debug/echo/<LNN>/<TOKEN>
/1/debug/echo/<TOKEN>
/1/debug/stats
/1/dedupe/dedupe-summary
/1/dedupe/reports
/1/dedupe/reports/<ID>
/1/dedupe/settings
/3/event/alert-conditions
/4/event/alert-conditions
/3/event/alert-conditions/<ID>
/4/event/alert-conditions/<ID>
/3/event/categories
/3/event/categories/<ID>
/3/event/channels
/3/event/channels/<ID>
/3/event/eventgroup-definitions
/4/event/eventgroup-definitions
/3/event/eventgroup-definitions/<ID>
/4/event/eventgroup-definitions/<ID>
/3/event/eventgroup-occurrences
/3/event/eventgroup-occurrences/<ID>
/3/event/eventlists
/3/event/eventlists/<ID>
/3/event/events
/3/event/settings
/3/file-filter/settings
/1/filepool/default-policy
/4/filepool/default-policy
/1/filepool/policies
/4/filepool/policies
/1/filepool/policies/<POLNAME>
/4/filepool/policies/<POLNAME>
/1/filepool/templates
/4/filepool/templates
/1/filepool/templates/<NAME>
/4/filepool/templates/<NAME>
/1/filesystem/settings/access-time
/1/filesystem/settings/character-encodings
/1/fsa/path
/1/fsa/results
/3/fsa/results
/1/fsa/results/<ID>
/3/fsa/results/<ID>
/3/fsa/results/<ID>/directories
/3/fsa/results/<ID>/directories/<LIN>
/3/fsa/results/<ID>/histogram
/3/fsa/results/<ID>/histogram/<STAT>
/3/fsa/results/<ID>/histogram/<STAT>/by
/3/fsa/results/<ID>/histogram/<STAT>/by/<BREAKOUT>
/3/fsa/results/<ID>/top-dirs
/3/fsa/results/<ID>/top-dirs/<STAT>
/3/fsa/results/<ID>/top-files
/3/fsa/results/<ID>/top-files/<STAT>
/1/fsa/settings
/5/groupnets-summary
/3/hardening/apply
/3/hardening/resolve
/3/hardening/revert
/3/hardening/state
/3/hardening/status
/3/hardware/fcports
/3/hardware/fcports/<port>
/3/hardware/tape/<name*>
/3/hardware/tapes
/4/id-resolution/paths
/4/id-resolution/paths/<LIN>
/1/job/events
/3/job/events
/1/job/job-summary
/1/job/jobs
/3/job/jobs
/1/job/jobs/<JID>
/1/job/policies
/1/job/policies/<NAME>
/3/job/recent
/1/job/reports
/3/job/reports
/1/job/statistics
/1/job/types
/1/job/types/<NAME>
/1/license/eula
/5/license/generate
/1/license/licenses
/5/license/licenses
/1/license/licenses/<NAME>
/5/license/licenses/<NAME>
/3/local/cluster/time
/3/local/cluster/version
/1/local/debug/echo/<LNN>/<TOKEN>
/3/local/upgrade/cluster/firmware/status
/3/network/dnscache
/3/network/dnscache/flush
/3/network/external
/3/network/groupnets
/3/network/groupnets/<GROUPNET>
/3/network/groupnets/<GROUPNET>/subnets
/4/network/groupnets/<GROUPNET>/subnets
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>
/4/network/groupnets/<GROUPNET>/subnets/<SUBNET>
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/interfaces
/4/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/interfaces
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rebalance-ips
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/rules/<NAME>
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/sc-resume-nodes
/3/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>/sc-suspend-nodes
/3/network/interfaces
/4/network/interfaces
/3/network/pools
/3/network/rules
/3/network/sc-rebalance-all
/3/network/subnets
/4/network/subnets
/3/protocols/ftp/settings
/5/protocols/hdfs/fsimage/job
/5/protocols/hdfs/fsimage/job/settings
/5/protocols/hdfs/fsimage/latest
/5/protocols/hdfs/fsimage/settings
/5/protocols/hdfs/inotify/settings
/5/protocols/hdfs/inotify/stream
/3/protocols/hdfs/log-level
/1/protocols/hdfs/proxyusers
/1/protocols/hdfs/proxyusers/<NAME>
/1/protocols/hdfs/proxyusers/<NAME>/members
/1/protocols/hdfs/proxyusers/<NAME>/members/<MEMBER>
/1/protocols/hdfs/racks
/1/protocols/hdfs/racks/<ID>
/4/protocols/hdfs/ranger-plugin/settings
/3/protocols/hdfs/settings
/4/protocols/hdfs/settings
/3/protocols/http/settings
/3/protocols/ndmp/contexts/backup
/3/protocols/ndmp/contexts/backup/<id>
/3/protocols/ndmp/contexts/bre
/3/protocols/ndmp/contexts/bre/<id>
/3/protocols/ndmp/contexts/restore
/3/protocols/ndmp/contexts/restore/<id>
/3/protocols/ndmp/diagnostics
/3/protocols/ndmp/dumpdates/<path*>
/3/protocols/ndmp/logs
/3/protocols/ndmp/sessions
/3/protocols/ndmp/sessions/<session>
/3/protocols/ndmp/settings/dmas
/3/protocols/ndmp/settings/global
/4/protocols/ndmp/settings/preferred-ips
/4/protocols/ndmp/settings/preferred-ips/<id>
/3/protocols/ndmp/settings/variables/<path*>
/3/protocols/ndmp/users
/3/protocols/ndmp/users/<name>
/2/protocols/nfs/aliases
/2/protocols/nfs/aliases/<AID>
/1/protocols/nfs/check
/2/protocols/nfs/check
/1/protocols/nfs/exports
/2/protocols/nfs/exports
/4/protocols/nfs/exports
/1/protocols/nfs/exports-summary
/2/protocols/nfs/exports-summary
/1/protocols/nfs/exports/<EID>
/2/protocols/nfs/exports/<EID>
/3/protocols/nfs/log-level
/3/protocols/nfs/netgroup
/3/protocols/nfs/netgroup/check
/3/protocols/nfs/netgroup/flush
/1/protocols/nfs/nlm/locks
/2/protocols/nfs/nlm/locks
/1/protocols/nfs/nlm/sessions
/2/protocols/nfs/nlm/sessions
/3/protocols/nfs/nlm/sessions
/3/protocols/nfs/nlm/sessions-check
/1/protocols/nfs/nlm/sessions/<ID>
/2/protocols/nfs/nlm/sessions/<ID>
/3/protocols/nfs/nlm/sessions/<ID>
/1/protocols/nfs/nlm/waiters
/2/protocols/nfs/nlm/waiters
/1/protocols/nfs/reload
/2/protocols/nfs/reload
/3/protocols/nfs/reload
/1/protocols/nfs/settings/export
/2/protocols/nfs/settings/export
/3/protocols/nfs/settings/global
/2/protocols/nfs/settings/zone
/3/protocols/ntp/servers
/3/protocols/ntp/servers/<SERVER>
/3/protocols/ntp/settings
/3/protocols/smb/log-level
/3/protocols/smb/log-level/filters
/3/protocols/smb/log-level/filters/<ID>
/1/protocols/smb/openfiles
/1/protocols/smb/openfiles/<ID>
/1/protocols/smb/sessions
/1/protocols/smb/sessions/<COMPUTER>
/1/protocols/smb/sessions/<COMPUTER>/<USER>
/1/protocols/smb/settings/global
/3/protocols/smb/settings/global
/6/protocols/smb/settings/global
/1/protocols/smb/settings/share
/3/protocols/smb/settings/share
/6/protocols/smb/settings/share
/6/protocols/smb/settings/zone
/1/protocols/smb/shares
/3/protocols/smb/shares
/4/protocols/smb/shares
/6/protocols/smb/shares
/1/protocols/smb/shares-summary
/1/protocols/smb/shares/<SHARE>
/3/protocols/smb/shares/<SHARE>
/6/protocols/smb/shares/<SHARE>
/3/protocols/snmp/settings
/5/protocols/snmp/settings
/3/protocols/swift/accounts
/3/protocols/swift/accounts/<ACCOUNT>
/1/quota/license
/5/quota/license
/1/quota/quotas
/1/quota/quotas-summary
/1/quota/quotas/<QID>
/1/quota/quotas/<QID>/notifications
/1/quota/quotas/<QID>/notifications/<NID>
/1/quota/reports
/1/quota/reports/<RID>
/1/quota/reports/<RID>/about
/1/quota/settings/mappings
/1/quota/settings/mappings/<ID>
/1/quota/settings/notifications
/1/quota/settings/notifications/<NID>
/1/quota/settings/reports
/1/remotesupport/connectemc
/1/snapshot/aliases
/1/snapshot/aliases/<SID>
/1/snapshot/changelists
/1/snapshot/changelists/<CHANGELIST>
/1/snapshot/changelists/<CHANGELIST>/lins
/1/snapshot/changelists/<CHANGELIST>/lins/<LIN>
/1/snapshot/license
/5/snapshot/license
/1/snapshot/pending
/1/snapshot/repstates
/1/snapshot/repstates/<REPSTATE>
/1/snapshot/schedules
/3/snapshot/schedules
/1/snapshot/schedules/<SID>
/1/snapshot/settings
/1/snapshot/snapshots
/1/snapshot/snapshots-summary
/1/snapshot/snapshots/<SID>
/1/snapshot/snapshots/<SID>/locks
/1/snapshot/snapshots/<SID>/locks/<LID>
/1/statistics/current
/1/statistics/history
/1/statistics/keys
/1/statistics/keys/<KEY>
/3/statistics/operations
/1/statistics/protocols
/3/statistics/summary/client
/3/statistics/summary/drive
/3/statistics/summary/heat
/3/statistics/summary/protocol
/3/statistics/summary/protocol-stats
/3/statistics/summary/system
/4/statistics/summary/workload
/1/storagepool/compatibilities/class/active
/1/storagepool/compatibilities/class/active/<ID>
/1/storagepool/compatibilities/class/available
/1/storagepool/compatibilities/ssd/active
/3/storagepool/compatibilities/ssd/active
/1/storagepool/compatibilities/ssd/active/<ID>
/3/storagepool/compatibilities/ssd/active/<ID>
/1/storagepool/compatibilities/ssd/available
/1/storagepool/nodepools
/3/storagepool/nodepools
/1/storagepool/nodepools/<NID>
/3/storagepool/nodepools/<NID>
/1/storagepool/settings
/5/storagepool/settings
/1/storagepool/status
/1/storagepool/storagepools
/3/storagepool/storagepools
/3/storagepool/suggested-protection/<NID>
/1/storagepool/suggested_protection/<NID>
/1/storagepool/tiers
/1/storagepool/tiers/<TID>
/1/storagepool/unprovisioned
/3/sync/history/cpu
/1/sync/history/file
/1/sync/history/network
/3/sync/history/worker
/1/sync/jobs
/3/sync/jobs
/1/sync/jobs/<JOB>
/3/sync/jobs/<JOB>
/1/sync/license
/5/sync/license
/1/sync/policies
/3/sync/policies
/1/sync/policies/<POLICY>
/3/sync/policies/<POLICY>
/1/sync/policies/<POLICY>/reset
/1/sync/reports
/4/sync/reports
/1/sync/reports-rotate
/1/sync/reports/<RID>
/4/sync/reports/<RID>
/1/sync/reports/<RID>/subreports
/4/sync/reports/<RID>/subreports
/1/sync/reports/<RID>/subreports/<SID>
/4/sync/reports/<RID>/subreports/<SID>
/1/sync/rules
/3/sync/rules
/1/sync/rules/<RULE>
/3/sync/rules/<RULE>
/1/sync/settings
/3.2/sync/settings
/3/sync/settings
/1/sync/target/policies
/1/sync/target/policies/<POLICY>
/1/sync/target/policies/<POLICY>/cancel
/1/sync/target/reports
/4/sync/target/reports
/1/sync/target/reports/<RID>
/4/sync/target/reports/<RID>
/1/sync/target/reports/<RID>/subreports
/4/sync/target/reports/<RID>/subreports
/1/sync/target/reports/<RID>/subreports/<SID>
/4/sync/target/reports/<RID>/subreports/<SID>
/3/upgrade/cluster
/4/upgrade/cluster
/3/upgrade/cluster/add_remaining_nodes
/3/upgrade/cluster/archive
/3/upgrade/cluster/assess
/5/upgrade/cluster/assess
/3/upgrade/cluster/commit
/3/upgrade/cluster/firmware/assess
/3/upgrade/cluster/firmware/progress
/3/upgrade/cluster/firmware/status
/3/upgrade/cluster/firmware/upgrade
/3/upgrade/cluster/nodes
/3/upgrade/cluster/nodes/<LNN>
/3/upgrade/cluster/nodes/<LNN>/firmware/status
/4/upgrade/cluster/nodes/<LNN>/patch/sync
/3/upgrade/cluster/patch/abort
/3/upgrade/cluster/patch/patches
/3/upgrade/cluster/patch/patches/<ID>
/3/upgrade/cluster/retry_last_action
/3/upgrade/cluster/rollback
/5.1/upgrade/cluster/rolling-reboot
/3/upgrade/cluster/upgrade
/5/upgrade/cluster/upgrade
/5/upgrade/hardware/start
/5/upgrade/hardware/status
/5/upgrade/hardware/stop
/1/worm/domains
/1/worm/domains/<DOMAIN+>
/1/worm/settings
/1/zones
/3/zones
/1/zones-summary
/1/zones-summary/<ZONE>
/1/zones/<ZONE>
/3/zones/<ZONE>