/scalemgmt/v3/filesystems/{filesystem}/snapshots: POST

Creates a global snapshot in an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/snapshots request creates a global file system snapshot at a single point of time. The snapshot does not copy system data or existing snapshots. This function enables backup or mirroring programs to run concurrently with user updates to ensure a consistent copy of the file system at the time of creation. Snapshots also serve as an online backup solution, allowing for easy recovery from common issues, such as accidental file deletion, and enabling comparisons with previous file versions.

A global snapshot is an exact copy of the changed data in the active files and directories of a file system. File system snapshots are read-only and appear in the .snapshots directory that is located in the root directory of the file system. The files and attributes of the file system can be modified only in the active copy.

To delete a global snapshot, use /scalemgmt/v3/filesystems/{filesystem}/snapshots/{snapshot_name}: DELETE or /scalemgmt/v3/filesystems/{filesystem}/snapshots:batchDelete: POST.

Because global snapshots are not full, independent copies of the entire file system, they do not provide protection against media failures. For more information about protecting against media failures, see Recoverability considerations.For more information about protecting against media failures, see the Recoverability considerations section in the IBM Storage Scale: Concepts, Planning, and Installation Guide.

For more information, see Creating and maintaining snapshots of file systems.For more information, see the Creating and maintaining snapshots of file systems section in the IBM Storage Scale: Administration Guide.

The operation attribute for this request is LRO. To run this request, you must have the RBAC permission for the create action on the /scalemgmt/v3/filesystems/{filesystem}/snapshots resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/snapshots
where
filesystems/{filesystem}/snapshots
Specifies the IBM Storage Scale filesystem snapshots as the target of the POST call.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystem The name of the file system. Required.
snapshot The body of the request that contains the required parameters to be passed on to the IBM Storage Scale system to perform the requested operation. Required.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 201: A successful response and the snapshot was created.
    {
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}
  • 202: The request has been accepted for processing, but the processing has not been completed.
    {
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Examples

The following example creates a file system global snapshot:

Request data: 
curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/snapshots' \
  -H 'accept: application/json' \
  -n -k
  -H 'Content-Type: application/json' \
  -d '{
  "name": "globalSnapshot"
}'
Response data: 
{
	"name": "MTo1MzM1ZjM5OS0xNmMwLTQzZDAtYjYxNi1hZGExMWU4Y2Q5ZWY=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo1MzM1ZjM5OS0xNmMwLTQzZDAtYjYxNi1hZGExMWU4Y2Q5ZWY=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.CreateFilesystemSnapshotRequest",
			"filesystem": "fs1",
			"snapshot": {
				"name": "globalSnapshot"
			}
		},
		"status": "DONE",
		"request_time": "2025-04-04T05:03:45.643645260Z",
		"completion_time": "2025-04-04T05:03:45.917496122Z",
		"last_update_time": "2025-04-04T05:03:45.917496122Z",
		"output": "Flushing dirty data for snapshot...",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.Snapshot",
		"name": "globalSnapshot"
	}
}