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

Snapshot and Clone Operations

All snapshot operations are scoped to a given pool or project. Snapshot operations can also be scoped to the filesystem or LUN level.

Table 12-24  Snapshot and Clone Commands
Request
Path /api/storage/v1
Description
GET
/snapshots
List all local snapshots
GET
/pools/<pool>/projects /<project>/snapshots
List all project snapshots
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots
List all filesystem snapshots
GET
/pools/<pool>/projects /<project>/luns/<lun> /snapshots
List all LUN snapshots
GET
/pools/<pool>/projects /<project>/snapshots/<snapshot>
Get project snapshot details
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
Get filesystem snapshot details
GET
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
Get LUN snapshot details
POST
/pools/<pool>/projects /<project>/snapshots
Create a project snapshot
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots
Create a filesystem snapshot
POST
/pools/<pool>/projects /<project>/luns/<lun> /snapshots
Create a LUN snapshot
PUT
/pools/<pool>/projects /<project>/snapshots/<snapshot>
Modify a project snapshot
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
Modify a filesystem snapshot
PUT
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
Modify a LUN snapshot
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/clone
Clone a filesystem snapshot
PUT
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>/clone
Clone a LUN snapshot
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/rollback
Rollback data to the given filesystem snapshot
PUT
/pools/<pool>/projects /<project>/lun/<lun> /snapshots/<snapshot>/rollback
Rollback data to the given LUN snapshot
DELETE
/pools/<pool>/projects /<project>/snapshots/<snapshot>
Destroy a project snapshot
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>
Destroy a filesystem snapshot
DELETE
/pools/<pool>/projects /<project>/luns/<lun> /snapshots/<snapshot>
Destroy a LUN snapshot
GET
/pools/<pool>/projects /<project>/snapshots/<snapshot> /dependents
List project snapshot dependents
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/snapshots /<snapshot>/dependents
List filesystem snapshot dependents
GET
/pools/<pool>/projects /<project>/lun/<lun> /snapshots/<snapshot> /dependents
List LUN snapshot dependents
POST
/pools/<pool>/projects /<project>/automatic
Create a new project automatic snapshot
GET
/pools/<pool>/projects /<project>/automatic /<automatic>
Get the specified project automatic snapshot properties
GET
/pools/<pool>/projects /<project>/automatic
List all project automatic snapshot objects
PUT
/pools/<pool>/projects /<project>/automatic /<automatic>
Modify the specified project automatic snapshot object
DELETE
/pools/<pool>/projects /<project>/automatic /<automatic>
Destroy the specified automatic object
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic
Create a new filesystem automatic snapshot
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
Get the specified filesystem automatic snapshot properties
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic
List all filesystem automatic snapshot objects
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
Modify the specified filesystem automatic snapshot object
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>/automatic /<automatic>
Destroy the specified automatic object
POST
/pools/<pool>/projects /<project>/luns/<lun>/automatic
Create a new LUN automatic snapshot
GET
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
Get the specified LUN automatic snapshot properties
GET
/pools/<pool>/projects /<project>/luns/<lun>/automatic
List all LUN automatic snapshot objects
PUT
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
Modify the specified LUN automatic snapshot object
DELETE
/pools/<pool>/projects /<project>/luns/<lun>/automatic /<automatic>
Destroy the specified automatic object