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

Deletes the fileset snapshot in an IBM Storage Scale fileset for the specified snapshot name.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name} request deletes a fileset snapshot. After deleting successfully, the snapshot is marked for deletion and cannot be recovered.

If the node from which delete is issued or the file system manager node fails, the snapshot might not be deleted fully. The list or get request displays these snapshots with a status of DeleteRequired. To complete the deletion, reissue the delete request from another node, or allow the snapshot to be automatically removed by a later scalectl fileset snapshot delete command. 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.

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

Request URL

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

where

{filesystem}: Specifies the name of the file system.
{fileset_name}: Specifies the name of the fileset.
{snapshot_name}: Specifies the name of the snapshot.

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.
fileset	The name of the fileset.	Required.
snapshot_name	The name of the snapshot.	Optional.
pit_continues	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 and the snapshot was deleted.

{
  "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"
  }
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example deletes the fileset snapshot for a specified snapshot name:

Request data:

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

Response data:

{
	"name": "MTo2ZWUzYzQyMy1lOTA4LTRjNWEtYWJmNi01OTEzMmZiZjI4OTE=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo2ZWUzYzQyMy1lOTA4LTRjNWEtYWJmNi01OTEzMmZiZjI4OTE=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.DeleteFilesetSnapshotRequest",
			"filesystem": "fs1",
			"fileset": "fileset1",
			"snapshot_name": "snapshot1"
		},
		"status": "DONE",
		"request_time": "2025-04-03T23:55:11.585999956Z",
		"completion_time": "2025-04-03T23:55:11.844574152Z",
		"last_update_time": "2025-04-03T23:55:11.844574152Z",
		"output": "Invalidating snapshot files in i...",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.DeleteSnapshotResponse",
		"name": "snapshot1"
	}
}