/scalemgmt/v3/filesystems/{filesystem}/snapshots/{snapshot_name}: DELETE

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

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/{filesystem}/snapshots/{snapshot_name} request deletes a global snapshot. After the delete is issued, the snapshot is marked for deletion and cannot be recovered.

If the node from which delete was issued or the file system manager node fails, the snapshot might not be fully deleted. The list or get subcommand displays these snapshots with a status of DeleteRequired. To complete the deletion, reissue delete subcommand from another node, or allow the snapshot to be automatically removed by a later /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name}: DELETE request. A snapshot in this state cannot be accessed.

Any open files in the snapshot are forcibly closed. The user receives an ESTALE error on the next file access.

If a snapshot contains file clones, you must delete the file clones or split them from their clone parents before deleting the snapshot. Use the mmclone split or mmclone redirect command to split file clones. Use a regular delete (rm) command to delete a file clone. If a snapshot containing a clone parent is deleted, any attempt to read a block that references the missing snapshot returns an error. A policy file can be created to help determine whether a snapshot contains file clones. For more information about file clones and policy files, see File clones and policy files.

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

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/snapshots/{snapshot_name}

where

{filesystem}: Specifies the name of the filesystem.
{snapshot_name}: Specifies the name of the filesystem snapshots.

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_name	The name of the snapshot.	Required.
pit_continues_on_error	Specifies to continue removing the remaining files, if errors are encountered in the parallel inode traverse (PIT) phase that performs user file deletion.	Optional.
target_nodes.node_list.nodes	The list of target IBM Storage Scale nodes.	Optional.
target_nodes.node_class.node_classes	The list of target IBM Storage Scale node classes.	Optional.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

No request data.

Response data

200: A successful response.

{
  "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 deletes a global file system snapshot for the specified snapshot name:

Request data:

curl -X 'DELETE' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/snapshots/globalSnapshot' -H 'accept: application/json' -n -k

Response data:

{
	"name": "MTo4NWFjZmM4Ny1mOWZkLTQ3ZGQtOWU3ZC1iNGFiZmRmMTZhYWI=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo4NWFjZmM4Ny1mOWZkLTQ3ZGQtOWU3ZC1iNGFiZmRmMTZhYWI=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.DeleteFilesystemSnapshotRequest",
			"filesystem": "fs1",
			"snapshot_name": "globalSnapshot"
		},
		"status": "DONE",
		"request_time": "2025-04-04T05:07:55.373066752Z",
		"completion_time": "2025-04-04T05:07:55.630393624Z",
		"last_update_time": "2025-04-04T05:07:55.630393624Z",
		"output": "Invalidating snapshot files in :...",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.DeleteSnapshotResponse",
		"name": "globalSnapshot"
	}
}