Ops Center Administrator REST API Reference Guide

Version: 11.0.x
Audience: anonymous
Part Number: MK-99ADM002-23
Published: 2025-09-15

Using the Ops Center Administrator REST API
REST architecture
API functionality and HTTP methods
Security and authentication
Privileges and roles
Identifying a resource
HTTP response
Token management resources
Getting a token
Creating a token
Deleting a token
Sending API requests using cURL
Block storage management resources
Storage system management
Listing storage systems
Getting a storage system
Getting storage systems summary
Getting storage system license information
Adding a storage system
Updating a storage system
Deleting a storage system
Switching the access point to GUM
Refreshing a storage system
Disk management
Listing disks
Getting a disk
Updating a disk
Parity group management resources
Listing parity groups
Getting a parity group
Listing parity groups summary
Listing external parity groups
Creating external parity groups
Initializing an external parity group
Deleting external parity groups
Getting an external parity group
Listing external parity groups summary
Creating a parity group
Enabling compression on a parity group
Initializing a parity group
Deleting a parity group
Getting parity group template
Creating parity group template
Pool management resources
Listing pools
Getting a pool
Getting pool summaries
Creating a pool
Updating a pool
Deleting a pool
Getting pool templates
Getting a specific pool template
Creating pool template
Updating a pool template
Volume management resources
Listing volumes
Getting a volume
Getting a volumes summary
Creating a volume
Updating a volume
Deleting a volume
Deleting volumes
Detaching volumes
Creating multiple volumes
Attaching volumes
Attaching and protecting volumes
Creating, attaching, and protecting volumes
Updating volumes
Detaching volumes from multiple servers
Editing volume LUN paths
Editing namespace paths
Getting auto-selection paths
Shredding volumes
Interrupting volume shredding
Host group management resources
Getting host groups
Getting a host group
Creating host groups
Editing a host group
Adding volumes to host groups
Removing volumes from host groups
Adding a mutual CHAP user of a host group
Updating a mutual CHAP user of a host group
Deleting a mutual CHAP user of a host group
Deleting host groups
NVM subsystem management resources
Listing NVM subsystems
Getting an NVM subsystem
Updating an NVM subsystem
Port management resources
Listing ports
Getting a port
Updating a port
Getting port login information
Tier management resources
Listing tiers
Updating a tier
Server management resources
Listing servers
Getting a server
Getting servers summary
Adding servers
Updating a server
Deleting a server
Deleting multiple servers
Updating world wide port names
Listing attached volumes
Updating iSCSI settings
Updating Host NVMe Qualified Names
Scanning host groups
Getting a list of server groups
Getting a server group
Listing volumes attached to servers in a server group
Creating a server group
Updating a server group
Adding servers to a server group
Deleting a server group
Removing multiple servers from a server group
Using existing LUN paths
Volume Migration resources
Attaching volumes to storage
Creating external volumes
Deleting external volumes
Discovering external devices
Listing external devices
Listing external volumes
Getting an external volume
Detaching volumes from storage
Listing migration tasks
Getting a migration task
Creating a migration task
Interrupting a running migration job
Updating a migration task
Deleting a migration task
Listing migration pairs
Fabric switch management resources
Listing fabric switches
Getting a fabric switch
Creating a fabric switch
Editing a fabric switch
Deleting a fabric switch
Virtual storage machine management resources
Listing virtual storage machines
Getting a virtual storage machine
Getting a physical storage system summary in a virtual storage machine
Listing volume IDs assigned to a physical storage system in a virtual storage machine
Listing volume IDs in a virtual storage machine
Getting a volume ID in a virtual storage machine
Listing host group IDs in a virtual storage machine
Getting a host group ID in a virtual storage machine
Creating a virtual storage machine
Adding resources to a virtual storage machine
Getting a virtual storage machine summary
Moving volumes to a virtual storage machine
Removing resources from a virtual storage machine
Removing defined volumes from a virtual storage machine
Deleting a physical storage system from a virtual storage machine
Deleting a virtual storage machine
Data protection management resources
Getting a data protection summary for all storage systems
Getting a data protection summary for a storage system
Listing replication groups
Getting a replication group by ID
Getting a replication group summary
Creating a replication group
Adding volumes to a replication group on a storage system
Removing volumes from a replication group on a storage system
Restoring volumes on a storage system
Updating clone replication groups on a storage system
Updating a snapshot replication group on a storage system
Updating high availability replication groups on a storage system
Suspending data replication
Resuming replication
Deleting a replication group
Listing volume pairs
Viewing volume pairs affected by actions performed on a replication group
Listing primary volume pairs
Listing secondary volume pairs
Listing secondary volumes for a primary volume
Listing failed volume pairs
Getting Ops Center Protector information
Registering/Deleting the Hitachi Ops Center Protector
Testing the connection to Ops Center Protector
Importing high availability pairs from Ops Center Protector
Listing quorum disks
Listing remote paths
Getting a high availability setup status summary
Listing high availability status external volumes
Monitoring resources
Capacity monitoring resources
Getting the total number of capacity alerts for all storage systems
Listing capacity alert details for all storage systems
Getting the total number of capacity alerts for a storage system
Listing capacity alert details for a storage system
Getting a summary of data reduction savings and capacity efficiency
Getting a data reduction savings and capacity efficiency summary for a storage system
Monitoring hardware resources
Getting the total number of hardware alerts for all storage systems
Listing resource-specific hardware alert details for all storage systems
Getting the total number of hardware alerts for a storage system
Listing resource-specific hardware alert details for a storage system
Listing disk alert information for all storage systems
Listing disk alert information for a storage system
SNMP resources
Listing SNMP managers
Adding SNMP managers
Updating an SNMP manager
Deleting an SNMP manager
System administration resources
Account domain resources
Listing account domains
Getting an account domain
Adding an account domain
Updating an account domain
Deleting an account domain
User management resources
Listing user groups
Listing group mappings
Getting a group mapping
Creating role mappings
Deleting role mappings
Listing users
Getting a user
Updating a user
Getting a job
Listing jobs
Listing storage system task information
Getting a storage system task information summary
Supported REST APIs list for Virtual Storage Platform One SDS Block
Supported REST APIs list for Virtual Storage Platform One SDS Block

Back to home page