NAS File Storage REST API Reference

Version: 15.6.x
File Size: 1291 KB
Audience: anonymous
Part Number: MK-92HNAS100-07
Published: 2026-04-07

Hardware and software requirements
Ports used by the REST API server
Hitachi file storage firmware requirements
Acquiring the correct IP address
Hitachi NAS Platform
VSP One File
VSP N series and VSP Gx00 and Fx00 with NAS modules
Authenticating with the REST API server
Applying API key restrictions
API common specifications
Resource URI format
HTTP methods
Non-CRUD operations
Required custom HTTP headers
Optional custom HTTP headers
HTTP status codes
Storage system error response
Basic data types
Large numbers
Inventory of supported APIs
Uniquely identifying each API call
Checking minor API version
Input and output format
Paging output
Sort output
Filter output
Output embedded
Preface
Servers
Authentication methods
Default authentication
Clustering Resource
Get the status of GEfN cluster
Get IPv6 intra-cluster communication state
Disable IPv6 intra-cluster communication
Enable IPv6 intra-cluster communication
Discovered node list
Delete quorum device
Get quorum device
Set quorum device
Get quorum device list
Join an existing cluster
Upgrade to a cluster
Delete a cluster node
Rename a cluster node
Data Migration Resource
Get data migration accounts
Create a data migration account
Delete data migration account
Get data migration account
Update a data migration account
Get data migration destinations
Create a data migration destination
Delete data migration destination
Get data migration destination
Update a data migration destination
Delete all data migration reports
Get data migration history reports
Get data migration detailed report file
Get data migration paths
Create an external data migration path
Create an internal data migration path
Delete data migration path
Get data migration path
Get data migration policies
Create a data migration policy
Delete data migration policy
Get data migration policy
Update a data migration policy
Get data migration policy history reports
Get recent data migration policy history reports
Delete data migration policy history report
Get data migration schedules for a data migration policy
Create data migration schedule for a data migration policy
Get data migration rules
Create a data migration rule
Delete data migration rule
Get data migration rule
Update a data migration rule
Get data migration policies using a rule
Get data migration schedules
Create a data migration schedule
Delete data migration schedule
Get data migration schedule
Update a data migration schedule
Abort data migration schedule
Start data migration schedule
Get data migration history reports for a file system
Get recent data migration history reports for a file system
Get data migration history reports for virtual server
Get recent data migration history reports for virtual server
Get data migration policies for a virtual server
Get data migration schedules for a virtual server
Alerts Resource
Get all event causes and resolutions
Get event cause and resolution
Get SMTP alerts
Set SMTP alerts
Get SMTP alert profiles
Add SMTP alert profile
Delete SMTP alert profile
Get SMTP alert profile
Update SMTP alert profile
Get SNMP alerts
Set SNMP alerts
Get syslog alerts
Set syslog alerts
File Devices Resource
Get a file device
Update file device details
Get status of all hardware components
Get network routes
Create a network route
Get per-cluster node routing status
Disable per-cluster node routing
Enable per-cluster node routing
Flush network routes
Delete a network route
Get a network route
Get performance info reports
Start performance info report
Abort running performance info report
Delete performance info report
Get performance info report status
Download performance info report
Interfaces Resource
Get advanced IP configuration
Get the global advanced IP configuration
Update the global advanced IP configuration
Reset the global advanced IP configuration
Delete advanced IP configuration from an interface
Get advanced IP configuration for an interface
Update advanced IP configuration for an interface
Create advanced IP configuration for an interface
Get aggregate interfaces
Create an aggregate interface
Upgrade aggregate interfaces after hardware change
Delete an aggregate interface
Get an aggregate interface
Modify an aggregate interface
Get ethernet interfaces
Get VLAN ethernet interfaces
Create a VLAN interface
Delete a VLAN interface
Get a VLAN ethernet interface
Get ethernet ports
Get status of file serving interface lane bonding
Disable file serving interface lane bonding
Enable file serving interface lane bonding
Get ethernet port
Set ethernet port speed and FEC setting
Reset ethernet port speed and FEC to default values
Get host ports
Get host port supported speeds
Get host port
Set host port
Licensing And Services Resource
Get cluster MAC
Get licensed features
Get license keys
Add license key
Delete license key
Get services
Get service
Disable service
Enable service
System Management Resource
Reset login banner to default
Get login banner
Update login banner
Get SNMP access config
Set SNMP access config
Get management access config
Set management access config
Get access level
Get API key groups
Create an API key group
Delete an API key group
Get an API key group
Update an API key group
Get API keys
Create an API key
Delete an API key
Get an API key
Update an API key
Get REST API calls
Get a REST API call
Update authentication for a REST API call
Get management users
Add management user
Delete management user
Get management user
Update management user password
Reboot cluster
Reboot cluster sequentially
Get registry file
Shutdown cluster
Get boot details
Get diagnostics for all nodes
Get node boot details
Get node diagnostics
Reboot node
Shutdown node
Date And Time Resource
Get NTP servers
Set NTP servers
Get system clock
Set system clock
Get timezone list
Get status of Time Protection feature
Disable Time Protection feature
Enable Time Protection feature
Reset Time Protection feature
Verify current system time
Filesystem Shares Resource
Create a file system share (CIFS/SMB)
Delete a file system share (CIFS/SMB)
Get a file system share (CIFS/SMB)
Update a file system share (CIFS/SMB)
Get CIFS share access authentications
Add CIFS share access authentications
Delete CIFS share access authentication entry
Update CIFS share access authentication entry
Create a file system share (NFS)
Delete a file system share (NFS)
Get a file system share (NFS)
Update a file system share (NFS)
Get file system shares associated with a virtual server (CIFS/SMB)
Get file system shares associated with a virtual server (NFS)
Filesystem Snapshots Resource
Create a file system snapshot
Get file system snapshots
Delete a file system snapshot
Get a file system snapshot
Rename a file system snapshot
Cancel the scheduled deletion for a file system snapshot
Set the retention period for a file system snapshot
Rollback file system to a snapshot
Get a file system snapshot size
Get default snapshot retention for a given file system
Set default snapshot retention for a given file system
Get file system snapshots associated with a file system
Filesystems Resource
Get file systems
Create a file system
Get deduplication file systems
Delete a file system
Get a file system
Update a file system
Set a file system as object replication target
Abort file system check or fix
Assign a file system to a virtual server
Change disaster recovery state of a file system
Initiate file system check
Get status of disaster recovery state change of a file system
Delete the log of a disaster recovery state change of a file system
Enable transfer raw XVLs for file system
Check if a file system path exists
Expand a file system
Format a file system
Mount a file system
Get replication snapshots from a target (destination)
Get the storage pool associated with a file system
Put a file system into syslocked mode
Take a file system out of syslocked mode
Set file system usage warning thresholds
Unassign a file system from its virtual server
Unmount a file system
Get the virtual server associated with a file system
Filesystem Auditing Resource
Get file system audit policies
Delete file system audit policy
Get file system audit policy
Update file system audit policy
Set file system audit policy
Delete file system audit log cache file for a virtual server
Get file system audit log cache file for a virtual server
Set file system audit log cache file for a virtual server
Disable file system audit log cache file for a virtual server
Enable file system audit log cache file for a virtual server
Get file system audit policies for a virtual server
Get default file system audit policy for a virtual server
Filesystem Directory Resource
Get all tree clone jobs
Get recent tree clone jobs
Get a tree clone job state of a file system directory
Abort a tree clone job of a file system directory
Get a tree clone job status report
Clone a file system directory
Clone a file system file
Get all tree clone jobs for a file system
Submit a tree clone job of a file system directory
Get recent tree clone jobs for a file system
Get root file system directory
Create a file system directory
Delete a file system directory
Get a file system directory
Rename a file system directory
Get details about any file system path
Set details for any file system path
Get details about a file system path
Set details for a file system path
Quotas Resource
Delete the default group quota template of a file system
Get the default group quota template of a file system
Set the default group quota template of a file system
Delete the default user quota template of a file system
Get the default user quota template of a file system
Set the default user quota template of a file system
Get user and group quotas of a file system
Get a file system group quota
Add a file system group quota
Get a file system user quota
Add a file system user quota
Delete a quota
Get a quota
Modify a quota
Delete the default group quota template for a virtual volume
Get the default group quota template for a virtual volume
Set the default group quota template for a virtual volume
Delete the default user quota template for a virtual volume
Get the default user quota template for a virtual volume
Set the default user quota template for a virtual volume
Get a virtual volumes quotas
Create a virtual volume quota
Get a virtual volume group quota
Add a virtual volume group quota
Get a virtual volume user quota
Add a virtual volume user quota
Security Settings Resource
Clear file system security mode
Get file system security mode
Set file system security mode
Get virtual server security context
Set virtual server security context
Get virtual server security mode
Set virtual server security mode
Clear virtual volume security mode
Get virtual volume security mode
Set virtual volume security mode
Statistics Resource
Get IO profile stats for a file system
Get client IO profile stats for a file system
Get busiest TCP connections
Get IO latency stats for all cluster nodes
Get IO profile stats for all cluster nodes
Get top N IO profile stats for all cluster nodes
Get client IO profile stats for all cluster nodes
Get busiest TCP connections for a node
Get IO profile stats for a node
Get top N IO profile stats for a node
Get client IO profile stats for a node
Get multiple file storage system statistics
Reset file storage node statistics
Get file storage node statistics
Get file storage system statistics
Get IO profile stats for a virtual server
Get client IO profile stats for a virtual server
Get IO profile stats for a virtual volume
Get client IO profile stats for a virtual volume
Virtual Volumes Resource
Get virtual volumes
Create a virtual volume
Delete a virtual volume
Get a virtual volume
Update a virtual volume
FTP Users Resource
Delete FTP user
Get an FTP user
Update an FTP user
Get FTP config
Set FTP config
Get FTP logging config for a virtual server
Set FTP logging config for a virtual server
Get FTP users for a virtual server
Add an FTP user to a virtual server
iSCSI Initiators Resource
Delete iSCSI initiator
Get iSCSI initiator
Update iSCSI initiator
Get iSCSI initiators of a virtual server
Add iSCSI initiator
Get iSNS servers for a virtual server
Add an iSNS server to a virtual server
Refresh iSNS server registration for a virtual server
Delete an iSNS server from a virtual server
iSCSI Logical Units Resource
Get iSCSI logical units
Create an iSCSI logical unit
Delete an iSCSI logical unit
Get an iSCSI logical unit
Update an iSCSI logical unit
Clone an iSCSI logical unit
Mount an iSCSI logical unit
Unmount an iSCSI logical unit
iSCSI Targets Resource
Get iSCSI targets
Create an iSCSI target
Delete an iSCSI target
Get an iSCSI target
Update an iSCSI target
Get all iSCSI logical units associated with an iSCSI target
Add an iSCSI logical unit to an iSCSI target
Delete an iSCSI logical unit from an iSCSI target
Local Groups Resource
Delete local group
Get local group
Get local group members
Add local group members
Delete local group member
Get local groups for a virtual server
Create local group for a virtual server
Lookup a security principal for a virtual server
Mappings Resource
Delete a mapping
Get a mapping
Update a mapping
Get domain mappings associated with a virtual server
Add domain mapping
Get group mappings associated with a virtual server
Add group mapping
Commit group mapping changes
Import group mappings
Refresh group mappings
Get user mappings associated with a virtual server
Add user mapping
Commit user mapping changes
Import user mappings
Refresh user mappings
Namespaces Resource
Delete a namespace
Get a namespace
Create path within a namespace
Delete a namespace path
Get a namespace path item
Update path within a namespace
Get root paths of a namespace
Get the contents of directory within a namespace
Get namespaces for a virtual server
Add a namespace to a virtual server
NDMP Resource
Get NDMP backup options
Set NDMP backup options
Clear NDMP backup history
Get NDMP devices
Refresh NDMP devices
Delete NDMP device
Get NDMP device
Update NDMP device
Assign NDMP device to virtual server(s)
Unassign NDMP device from its virtual server(s)
Disable NDMP
Enable NDMP
Get NDMP snapshot options
Set NDMP snapshot options
Nodes Resource
Get nodes
Set user-defined event
Get a node
Clear node events
Get node events
Get IP address details for a node
Get IP addresses of a node
Set a node IP address
Delete an IP address from node
Virtual Server Migration Resource
Migrate all node virtual servers to another node
Get virtual server automatic failback
Disable virtual server automatic failback
Enable virtual server automatic failback
Migrate virtual servers to preferred nodes
Get preferred node for all virtual servers
Set preferred node for all virtual servers
Migrate virtual server to specific cluster node
Clear virtual server preferred node
Set virtual server preferred node
Object Replication Resource
Get object replication policies
Create an object replication policy
Delete an object replication policy
Get an object replication policy
Modify an object replication policy
Delete all object replication reports
Get all object replication reports
Get an object replication last report
Get object replication schedules for an object replication policy
Create an object replication schedule
Modify snapshot rule names of an object replication policy
Start an object replication
Stop an object replication
Get the object replication listening port
Set the object replication listening port
Delete an object replication schedule
Get an object replication schedule
Update an object replication schedule
Get object replication policies for a virtual server
Get object replication schedules for a virtual server
Serving Names Resource
Delete a serving name from a virtual server
Get a serving name of a virtual server
Disable NetBios
Enable NetBios
Disable DDNS for a virtual server
Enable DDNS for a virtual server
Get domain details for a virtual server
Get serving names of a virtual server
Add a serving name to a virtual server
Snapshot Rules Resource
Create a snapshot rule
Delete a snapshot rule
Get a snapshot rule
Modify a snapshot rule
Create a file system snapshot from a snapshot rule
Add a snapshot schedule to a snapshot rule
Delete a snapshot schedule associated with a snapshot rule
Get a snapshot schedule associated with a snapshot rule
Delete snapshot rules
Get snapshot rules
Storage Pools Resource
Get storage pools
Create a storage pool
Get storage pool default capacity warning threshold
Set storage pool default capacity warning threshold
Get storage theoretical limits
Delete a storage pool
Get a storage pool
Update a storage pool
Assign storage pool to the cluster
Get storage pool on disk configuration backup
Expand a storage pool
Get file systems associated with a storage pool
Get HDP storage pool info
Get stripesets associated with a storage pool
Get stripeset details associated with a storage pool
Update stripeset associated with a storage pool
Get system drives associated with a storage pool
System Drives Resource
Get system drives
Get system drive licensed sizes
Refresh SCSI system drives
Delete system drive
Get a system drive
Update a system drive
Get path info for a system drive
Get port info for a system drive
Virtual Servers Resource
Get virtual servers
Create a virtual server
Get NFS supported versions
Set NFS supported version
Create virtual server from registry file
Get barred SMB clients
Delete a virtual server
Get a virtual server
Rename a virtual server
Disable a virtual server
Enable a virtual server
Get IP address details for a virtual server
Get IP addresses of a virtual server
Add an IP address to a virtual server
Delete an IP address from a virtual server
Update IP address details for a virtual server
Get iSCSI domain
Set iSCSI domain
Get the node associated with a virtual server
Get registry file for a virtual server
Clear virtual server barred SMB clients
Get virtual server barred SMB clients
Add SMB client to virtual server barred client list
Delete SMB client from virtual server barred client list
Get SMB supported versions for a virtual server
Set SMB supported versions for a virtual server
Get virus scan info of a virtual server
Set virus scan details for a virtual server
Request full virus scan on a virtual server
Clear virus scan inclusion list for a virtual server
Get virus scan inclusion list for a virtual server
Set virus scan inclusion list for a virtual server
Reset virus scan inclusion list for a virtual server
Add an ICAP virus scan server to a virtual server
Delete a virus scan server from a virtual server
Update an ICAP virus scan server for a virtual server
Name Services Resource
Get name service order for a virtual server
Set name service order for a virtual server
Get DNS config for a virtual server
Update DNS config for a virtual server
Get LDAP config for a virtual server
Update LDAP config for a virtual server
Get LDAP search config for a virtual server
Get NIS config for a virtual server
Update NIS config for a virtual server
Get virtual server NIS LDAP mode
Set NIS LDAP mode for a virtual server
Get WINS config for a virtual server
Set WINS config for a virtual server

Back to home page