Get Started with the Oracle FS System RESTful API

You can monitor and manage an Oracle FS System using the Oracle FS System Representational State Transfer (REST) Application Programming Interface (API). Based on a layered client-server model, the RESTful architecture permits services to be transparently redirected through standard hubs, routers, and other network systems.

The core functionality of Oracle FS System RESTful API is built on top of the Oracle FS CLI (FSCLI) and the implementation maps to existing FSCLI commands. See the Oracle Flash Storage System CLI Reference on the Oracle Help Center (www.oracle.com/goto/FSStorage/docs) if you are not familiar with the FSCLI.

The Oracle FS System RESTful API includes the following features:
HTTP Verbs

Uses HTTP to implement REST. The RESTful API supports the following HTTP verbs: GET, POST, PUT, and DELETE. The GET, PUT, and DELETE verbs observe all HTTP semantics, such as idempotency.

Port Information

Accessible on the SSL secure port 8085.

Resources

Resources are the main abstraction in Oracle FS System RESTful API. Resources are anything that can have an ID or fully qualified name (FQN) associated with it. Only those resources that correspond to FSCLI commands are accessible.

CGI Query Strings

The HTTP GET verb does not support using a message body to provide additional options. Instead, the standard is to use CGI query string parameters. The Oracle FS System RESTful API supports the use of CGI query strings in the URI supplied with the GET command.

Request Formats

Supports both XML‑formatted and JSON‑formatted message bodies to specify the options contained in message bodies needed for POST, PUT, and some DELETE requests.

Response Formats

Responses from all Oracle FS System RESTful API GET, POST, PUT, or DELETE verbs are either an XML format or a JSON format.