JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Print View
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Overview


Basic Authentication

User Authentication

Session Authentication

API Versions

Service Versions

Common RESTful Operations

HTTP Response Body

HTTP Response Headers

Query Parameters





Chapter 2 Working with the API

Chapter 3 Alert Service Commands

Chapter 4 Analytics Services

Chapter 5 Hardware Services

Chapter 6 Log Commands

Chapter 7 Network Commands

Chapter 8 Problem Service Commands

Chapter 9 Role Service

Chapter 10 SAN Services

Chapter 11 Service Commands

Chapter 12 Storage Services

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Chapter 1


The Oracle ZFS Storage Appliance (ZFSSA) is a family of enterprise storage products that provides efficient file and block data services over the network. This guide describes the ZFSSA RESTful Application Programming Interface (API). This API can be used to manage the ZFS Storage Appliance. This documentation is organized using the same hierarchy as the Browser User Interface (BUI) and Command Line Interface (CLI).

Cloud environments typically use a RESTful architecture, which is based on a layered client-server model. This layered model allows services to be transparently redirected through standard hubs, routers, and other network systems without client con?guration.