Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

PowerScale OneFS API Reference

PDF

OneFS API access

By applying standard HTTP methods to resource URIs, you can modify file system settings or access content on any node in a cluster through the OneFS API. When making multiple changes through the OneFS API, it is recommended that you send all requests to a single node to avoid configuration collisions.

OneFS API resource URIs are composed of the following components.

Component Definition
my_cluster The IPv4 or IPv6 address or hostname for the cluster.
obj_port The number of the port. The default setting is 8080.
access_point The name of the access point, such as /ifs.
resource_path The file path to the directory that you want to access.
api_version The version of the OneFS API. It is an optional component, as OneFS automatically uses the latest API.
collection_pattern The namespace, collection name, and object ID of the resource that you want to configure.

In both types of API requests, you can append query parameters to the end of resource URIs to refine your request. For example, you can revise a GET request to return only a set number of entries. In the following example, a maximum of 1,000 SMB shares are returned: 

GET https://192.168.1.100:8080/platform/14/protocols/smb/shares?limit="1000"

File system configuration API requests

For file system configuration API requests, the resource URI is composed of the following components: 

https://<my_cluster>:<obj_port>/<api-version>/<collection_pattern>

For example, you can send a GET request to the following URI to retrieve all SMB shares on a cluster. Where protocols is the namespace, SMB is the collection name, and shares is the object ID: 

GET https://192.168.1.100:8080/platform/14/protocols/smb/shares

File system access API requests

For file system access APIs requests, the resource URI is composed of the following components: 

https://<my_cluster>:<obj_port>/namespace/<access_point>/<resource_path>

For example, you can send a GET request to the following URI to view files that are stored in the folder at /ifs/users/folder1: 

GET https://192.168.0.25:8080/namespace/ifs/users/folder1
For example, you can send a PUT request to the following URI to copy files that are stored in the folder to another location: 
PUT https://10.7.146.164:8080/namespace/user1store/dir6
If you specify the header x-isi-ifs-mode-mask value as preserve, then it copies the file/dir mode, ownership, ACL, timestamps information along with file data.

Also, in file system access API requests, you can indicate a special operation in your request by appending a predefined keyword to the end of the resource URI. These keywords must be placed first in the argument list and must not contain any value. If these keywords are placed in any other position in the argument list, the keywords are ignored. Predefined keywords are acl, metadata, worm, and query. For example: 

GET https://192.168.0.25:8080/namespace/ifs/users/folder1?acl

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\