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

Document Information

Using This Documentation

Chapter 1 Overview

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

Storage Pool Operations

List Pools

Get Pool

Configure Pool

Add Storage to a Pool

Pool Scrub

Unconfigure Pool

Project Operations

List Projects

Get Project Properties

Create Project

Modify Project

Delete Project

Project Usage

Filesystem Operations

List Filesystems

Get Filesystem

Create Filesystem

Modify Filesystem

Delete Filesystem

Filesystem Quota and Usage

LUN Operations

List LUNS

Get LUN

Create a New LUN

Modify LUN

Delete Lun

Snapshot and Clone Operations

List Snapshots

Get Snapshot

Create Snapshot

Rename Snapshot

Clone Snapshot

Rollback Snapshot

Delete a Snapshot

List Snapshot Dependents

Schema

List Properties

Get Property

Create Property

Modify Property

Delete Property

Replication

Get Replication Service

Modify Replication Service State

Replication Targets

List Replication Targets

Get Replication Target

Create Replication Target

Delete Replication Target

Replication Actions

List Replication Actions

Get Replication Action

Create Replication Action

Modify Replication Action

Cancel Update

Send Update

Delete a Replication Action

Replication Packages

List Replication Sources

List Replication Packages

Modify Package

Delete Package

Cancel Update

Clone Package

Sever Package

Reverse Package

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Project Operations

All project operations can be scoped to a given pool. Commands that operate across all projects append "/projects" to the URI, and commands that operate on a single project append "/projects/{project}".

Table 12-3  Project Commands
Request
Path /api/storage/v1
Description
GET
/projects
List all projects
GET
/pools/<pool>/projects
List projects
GET
/pools/<pool>/projects /<project>
Get project details
POST
/pools/<pool>/projects
Create a project
PUT
/pools/<pool>/projects /<project>
Modify a project
DELETE
/pools/<pool>/projects /<project>
Destroy a project
GET
/pools/<pool>/projects /<project>/usage/groups
Get project group usage
GET
/pools/<pool>/projects /<project>/usage/groups/<group>
Get project usage for the specified group
GET
/pools/<pool>/projects /<project>/usage/users
Get project user usage
GET
/pools/<pool>/projects /<project>/usage/users/<user>
Get project usage for the specified user

The following table shows the list of editable properties within a project resource.

Table 12-4  Project Properties
Type
Name
Description
string
aclinherit
ACL inheritance behavior ("discard", "noallow", "restricted", "passthrough" "passthrough-x")
string
aclmode
ACL behavior on mode change ("discard", "mask", "passthrough")
boolean
atime
Update access time on read flag
string
canonical_name
Canonical name
string
checksum
Block checksum ("fletcher2", "fletcher4", "sha256")
string
compression
Data compression setting ("off", "lzjb", "gzip-2", "gzip", "gzip-9")
number
copies
Number of additional replication copies
datetime
creation
Date and time of project (or LUN, filesystem) creation
boolean
dedup
Data deduplication flag
string
default_group
Project default filesystem group: "other"
string
default_permissions
Project default filesystem permissions "700"
boolean
default_sparse
Project default LUN sparse data flag
string
default_user
Project default filesystem user: "nobody"
number
default_volblocksize
Project default LUN blocksize: 8192
number
default_volsize
Project default LUN Size
boolean
exported
Exported flag
string
logbias
Synchronous write bias ("latency", "throughput")
string
mountpoint
Share mountpoint default "/export/proj-01"
string
name
Project Name
boolean
nbmand
Non-blocking mandatory locking flag
boolean
nodestroy
Prevent destruction flag
number
quota
Project Quota Size in bytes
string
origin
Clone origin
string
pool
Pool namels
boolean
readonly
Data is read only if set to true
string
recordsize
Database record size "128k"
number
reservation
Data Reservation Size
boolean
rstchown
Restrict Ownership change flag
string
secondarycache
Secondary Cache Usage ("all", "metadata", "none")
string
sharedav
HTTP share ("off", "rw", "ro")
string
shareftp
FTP share ("off", "rw", "ro")
string
sharenfs
NFS share ("off", "on", "ro", "rw")
string
sharesftp
SFTP share ("off", "rw", "ro")
string
sharesmb
SMB/CIFS share ("off", "rw", "ro")
string
sharetftp
TFTP share ("off", "rw", "ro")
string
snapdir
.zfs/snaphsot visibility ("hidden", "visible")
string
snaplabel
Scheduled Snapshot Label
boolean
vscan
Virus Scan flag