Writable-Snapshots (v2) - CRUD Operations for Writable Snapshots

Introduction

The Superna Eyeglass REST API - v2 Writable-Snapshots allows for the management of writable snapshots on OneFS clusters, providing capabilities to delete, view, create, and check the status of snapshot jobs. Writable snapshots on 9.2 or later OneFS clusters. These features replace the legacy LiveOps SyncIQ-based solution. This can create a writable snapshot on any path and replicate the data into another path or access zone with all shares, exports, and quotas cloned into the test zone. The delete feature will delete the writable snapshot.

Use Cases:

• DR Testing
• Application upgrade testing
• Dev/ops on application development using a virtual view of production data

Endpoints

DELETE /v2/writable-snapshots

Description:

This endpoint deletes a writable snapshot in Superna Eyeglass.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
sourceSnap	required	Specifies the source snapshot to be deleted	query	string
targetPath	required	Target path for the writable snapshot	query	string
ne	required	Name of the cluster	query	string
deleteConfig	required	Configuration flag indicating deletion settings	query	string

Response Codes:

• 200 OK: Successfully deleted the writable snapshot.
• default: Error payload, see response structure below.

Example Response (Success):

{
  "jobId": "string",
  "message": "string",
  "snapshots": [
    {
      "created": "string",
      "ne": "string",
      "sourcePath": "string",
      "sourceSnap": "string",
      "targetPath": "string"
    }
  ],
  "success": "string"
}

Example Response (Error):

{
  "code": 0,
  "message": "string"
}

GET /v2/writable-snapshots

This endpoint retrieves all recent writable snapshots jobs in Superna Eyeglass.

Description:

View all recent writable snapshots jobs.

Response Codes:

• 200 OK: Returns information about all writable snapshot jobs.
• default: Error payload, see response structure below.

Example Response (Success):

{
  "jobId": "string",
  "message": "string",
  "snapshots": [
    {
      "created": "string",
      "ne": "string",
      "sourcePath": "string",
      "sourceSnap": "string",
      "targetPath": "string"
    }
  ],
  "success": "string"
}

Example Response (Error):

{
  "code": 0,
  "message": "string"
}

POST /v2/writable-snapshots

Description:

This endpoint starts a job to create a writable snapshot in Superna Eyeglass.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
ne	required	Cluster Name	query	string
targetPath	required	Target path for writable snapshot	query	string
sourcePath	required	Source path for writable snapshot	query	string
copyConfigFlag	required	Flag for copy config while creating writable snapshot (true/false)	query	string

Response Codes:

• 200 OK: Status of writable snapshot job.
• default: Error payload, see response structure below.

Example Response (Success):

{
  "jobId": "string",
  "message": "string",
  "snapshots": [
    {
      "created": "string",
      "ne": "string",
      "sourcePath": "string",
      "sourceSnap": "string",
      "targetPath": "string"
    }
  ],
  "success": "string"
}

Example Response (Error):

{
  "code": 0,
  "message": "string"
}

GET /v2/writable-snapshots/jobStatus

Description:

This endpoint retrieves the status of a writable snapshots job by ID in Superna Eyeglass.

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
jobId	required	Job ID	query	string

Response Codes:

• 200 OK: Returns the status of the specified writable snapshot job.
• default: Error payload, see response structure below.

Example Response (Success):

{
  "childrenDetails": [
    {}
  ],
  "finished": 0,
  "id": "string",
  "info": "string",
  "name": "string",
  "started": 0,
  "state": "string",
  "status": "string"
}

Example Response (Error):

{
  "code": 0,
  "message": "string"
}