List of IBM Storage Scale native REST API endpoints
The administration daemon supports a REST API that allows applications to communicate with it directly, without the use of scalectl command-line interface. The following table lists the currently supported REST API operations for each type of resource and resource element. The first and second columns list the resource type and the operation. The third column lists the resource and resource element terms that appear in the HTTPS request. The braces {} are a notation for indicating a resource element in text and do not appear in the actual HTTPS request. The fourth column lists the HTTP method that is called to do the operation.
Note: You can access the documentation corresponding to each API endpoint from the OpenAPI
specification at https://x.x.x.x:46443/openapi/, where x.x.x.x is the public IP
address of the API server node. Ensure that the trailing slash (/) is included in the URL.
| Resource type | Operation | Resource/{element} | Method |
|---|---|---|---|
| API-health | Lists the health status of the IBM Storage Scale native REST API services on nodes. | /scalemgmt/v3/apihealth | GET |
| Lists the health status of the IBM Storage Scale native REST API services on the specified node. | /scalemgmt/v3/apihealth/{node_name} | GET | |
| Authorization | Checks whether the current user is authorized to perform an action on a resource in the domain. | /scalemgmt/v3/authorization/cani | POST |
| Checks whether the specified user is authorized to perform an action on a resource in the domain. | /scalemgmt/v3/authorization/cani:impersonate | GET | |
| Lists information about all domains. | /scalemgmt/v3/authorization/domains | GET | |
| Creates a role-based access control (RBAC) domain. | /scalemgmt/v3/authorization/domains | POST | |
| Lists information about the RBAC domain for the specified domain name. | /scalemgmt/v3/authorization/domains/{name} | GET | |
| Deletes the domain for the specified name. | /scalemgmt/v3/authorization/domains/{name} | DELETE | |
| Updates the domain for the specified name. | /scalemgmt/v3/authorization/domains/{name} | PATCH | |
| Updates the customer-defined policy rule set. . |
/scalemgmt/v3/authorization/module | PATCH | |
| Gets details of the CLI commands that are issued on the cluster. | /scalemgmt/v3/authorization/module | GET | |
| Cluster | Lists information about the cluster. | /scalemgmt/v3/clusters | GET |
| Creates the IBM Storage Scale cluster. | /scalemgmt/v3/clusters | POST | |
| Migrates a classic IBM Storage Scale cluster to the use of IBM Storage Scale native REST API. | /scalemgmt/v3/clusters:migrate | POST | |
| Configuration | Lists information about the current configuration data for the administration daemon that is stored on a disk. | /scalemgmt/v3/config/admin | GET |
| Lists information about the configuration data of the administration daemon for the specified attribute. | /scalemgmt/v3/config/admin/{name} | GET | |
| Updates the configuration value of an administration daemon. | /scalemgmt/v3/config/admin:batchUpdate | PATCH | |
| Lists the current configuration data for the I/O daemon that is stored on a disk. | /scalemgmt/v3/config/cluster | GET | |
| Lists information about the I/O daemon configuration value for the specified attribute. | /scalemgmt/v3/config/cluster/{name} | GET | |
| Updates the configuration value of an IO daemon. | /scalemgmt/v3/config/cluster:batchUpdate: | PATCH | |
| Diagnostics | Lists mmfsd version of the node. | /scalemgmt/v3/nodes/{node}/diagnostics/version | GET |
| File system | Lists information about all IBM Storage Scale file systems in an IBM Storage Scale cluster. | /scalemgmt/v3/filesystems | GET |
| Creates an IBM Storage Scale file system. | /scalemgmt/v3/filesystems | POST | |
| Lists information about the specified IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem} | GET | |
| Lists the mount state of an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}:mount | GET | |
|
Mounts an IBM Storage Scale file system. |
/scalemgmt/v3/filesystems/{filesystem}:mount | POST | |
| Unmounts an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}:unmount | POST | |
| Deletes an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{name} | DELETE | |
| Updates the attributes of an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{name} | PATCH | |
| Mounts all IBM Storage Scale file systems. | /scalemgmt/v3/filesystems:mount | POST | |
|
Unmounts all IBM Storage Scale file systems. |
/scalemgmt/v3/filesystems:unmount | POST | |
| File system disk | Lists information about all disks in an IBM Storage Scale file system | /scalemgmt/v3/filesystems/{filesystem}/disks | GET |
| Adds disks in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/disks | POST | |
| Lists information about the specified disk in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/disks/{disk_name} | GET | |
| Deletes a disk in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/disks/{disk_name} | DELETE | |
| Add a batch of disks from an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/disks:batchAdd | POST | |
| Deletes a batch of disks in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/disks:batchDelete | POST | |
| Lists information about the disk quorum. | /scalemgmt/v3/filesystems/{filesystem}/disksquorum | GET | |
| Fileset | Lists filesets in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/filesets | GET |
| Creates an IBM Storage Scale fileset. | /scalemgmt/v3/filesystems/{filesystem}/filesets | POST | |
| Gets details of the fileset for the specified name. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name} | GET | |
| Deletes the fileset for the specified name. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name} | DELETE | |
| Updates attributes of the fileset for the specified name. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name} | PATCH | |
| Retrieves the fileset inode usage, data usage, or both. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}/usage | GET | |
| Links an IBM Storage Scale fileset. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:link | POST | |
| Unlinks an IBM Storage Scale fileset. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}:unlink | POST | |
| Manager | Updates the cluster manager node. | /scalemgmt/v3/clusters/manager | POST |
| Update the manager node of an existing file system. | /scalemgmt/v3/filesystems/{name}/manager | POST | |
| Node | Adds a node to the IBM Storage Scale cluster. | /scalemgmt/v3/nodes | POST |
| Starts the mmfsd service on a node. | /scalemgmt/v3/nodes:start | POST | |
| Get the status of the node. | /scalemgmt/v3/nodes/status | GET | |
| Stops mmfsd on a cluster node. | /scalemgmt/v3/nodes:stop | POST | |
| Lists the configuration details of the node. | /scalemgmt/v3/nodes/config | GET | |
| Node class | Lists all node classes that are registered to the cluster. | /scalemgmt/v3/nodeclasses | GET |
| Creates user-defined node classes. | /scalemgmt/v3/nodeclasses | POST | |
| Lists the members of the specified node class. | /scalemgmt/v3/nodeclasses/{name} | GET | |
| Deletes an existing node class. | /scalemgmt/v3/nodeclasses/{name} | DELETE | |
| Updates an existing node class. | /scalemgmt/v3/nodeclasses/{name} | PATCH | |
| NSD | Lists information about all network-shared disks (NSDs) that are part of the system. | /scalemgmt/v3/nsds | GET |
| Creates a network-shared disk in an IBM Storage Scale cluster. | /scalemgmt/v3/nsds | POST | |
| Lists information about the specified NSD. | /scalemgmt/v3/nsds/{nsd_name} | GET | |
| Deletes the specified NSD. | /scalemgmt/v3/nsds/{nsd_name} | DELETE | |
| Updates an existing NSD. | /scalemgmt/v3/{nsd_name} | PATCH | |
| Creates one or more NSDs that are used by IBM Storage Scale. | /scalemgmt/v3/nsds:batchCreate | POST | |
| Deletes one or more network-shared disks (NSD) that are used by IBM Storage Scale. | /scalemgmt/v3/nsds:batchDelete | POST | |
| Operations | Lists information about all long-running operations (LROs). | /scalemgmt/v3/operations | GET |
| Lists details of the LRO for the specified ID. | /scalemgmt/v3/operations/{id} | GET | |
| Delete the LRO for the specified ID. | /scalemgmt/v3/operations/{id} | DELETE | |
| Gets the output details of the LRO. | /scalemgmt/v3/operations/{id}/output | GET | |
| Cancels the running LRO. | /scalemgmt/v3/operations/{id}:cancel | POST | |
| Policy | Lists information about the file system policy. | /scalemgmt/v3/filesystems/{filesystem}/policy | GET |
| Updates the file system policy. | /scalemgmt/v3/filesystems/{filesystem}/policy | PATCH | |
| Remote cluster | Lists information about remote clusters. | /scalemgmt/v3/clusters/remote | GET |
| Adds an owning cluster to the set of remote clusters known to the accessing cluster. | /scalemgmt/v3/clusters/remote | POST | |
|
Authorizes an accessing cluster to access resources on the owning cluster. |
/scalemgmt/v3/clusters/remote/authorized | POST | |
| Deletes an accessing cluster authorization from the owning cluster. | /scalemgmt/v3/clusters/remote/authorized/{name} | DELETE | |
| Retrieves details of a remote cluster. | /scalemgmt/v3/clusters/remote/{name} | GET | |
|
Deletes an owning cluster definition from the accessing cluster. |
/scalemgmt/v3/clusters/remote/{name} | DELETE | |
| Updates information associated with a remote cluster in this cluster. | /scalemgmt/v3/clusters/remote/{name} | PATCH | |
| Refreshes the information of an owning cluster on the accessing cluster. | /scalemgmt/v3/clusters/remote/{name}/refresh | POST | |
| Remote file system | Adds a remote file system. | /scalemgmt/v3/filesystems/remote | POST |
| Deletes a remote file system. | /scalemgmt/v3/filesystems/remote/{filesystem}: | DELETE | |
| Updates the information associated with a remote file system. | /scalemgmt/v3/filesystems/remote/{filesystem} | PATCH | |
| Snapshot | Lists global snapshots in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/snapshots | GET |
| Creates a global snapshot in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/snapshots | POST | |
| Gets information for an IBM Storage Scale global snapshot. | /scalemgmt/v3/filesystems/{filesystem}/snapshots/{snapshot_name} | GET | |
| Delete a global snapshot in an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/snapshots/{snapshot_name} | DELETE | |
| Displays the current snapshot directory settings. | /scalemgmt/v3/filesystems/{filesystem}/snapshots:snapdir. | GET | |
| Deletes one or more global snapshots. | /scalemgmt/v3/filesystems/{filesystem}/snapshots:batchDelete | POST | |
| Creates one or more fileset snapshots. | /scalemgmt/v3/filesystems/{filesystem}/filesets/snapshots:batchCreate | POST | |
| Deletes one or more fileset snapshots. | /scalemgmt/v3/filesystems/{filesystem}/filesets/snapshots:batchDelete | POST | |
| Lists fileset snapshots in an IBM Storage Scale fileset. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots | GET | |
| Creates an IBM Storage Scale fileset snapshot. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots | POST | |
| Gets details about the fileset snapshot in an IBM Storage Scale fileset for the specified snapshot name. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name} | GET | |
| Deletes the fileset snapshot in an IBM Storage Scale fileset for the specified snapshot name. | /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name} | DELETE | |
| Storage pool | Lists details of storage pools of an IBM Storage Scale file system. | /scalemgmt/v3/filesystems/{filesystem}/storagepools | GET |
| Lists details of the specified storage pool. | /scalemgmt/v3/filesystems/{filesystem}/storagepools/{pool_name} | GET | |
| Updates an existing storage pool. | /scalemgmt/v3/filesystems/{filesystem}/storagepools/{pool_name} | PATCH | |
| Troubleshooting | Reads persistent reserve registration key values from a device. | /scalemgmt/v3/troubleshooting/persistentReserve/{device}/keys | GET |
| Clears the persistent reserve registration key values from a device. | /scalemgmt/v3/troubleshooting/persistentReserve/{device}/keys | DELETE | |
| Deletes the NSD volume ID from a device. | /scalemgmt/v3/troubleshooting/nsds/clearID | DELETE | |
| Version | Lists the version of the scaleadmd service. | /scalemgmt/v3/version | GET |
| For more information about the endpoints, see IBM Storage Scale native REST API endpoints. | |||