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

Deletes one or more global snapshots.

Availability

Available on all IBM Storage Scale editions.

Description

The POST filesystems/{filesystem}/snapshots:batchDelete request deletes one or more global snapshots. 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}/snapshots:batchDelete resource.

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.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/snapshots
where
{filesystem}
Specifies the file system name.

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.
body 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

  • 200: A successful response and one or more snapshots were 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 batch deletes snapshots:

Request data: 
curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/snapshots:batchDelete' \
  -H 'accept: application/json' \
  -n -k
  -H 'Content-Type: application/json' \
  -d '{
  "pit_continues_on_error": true,
  "snapshots": [
    {
      "name": "globalSnap1"
    },
    {
      "name": "globalSnap2"
    }
  ]
}'
Response data: 
{
	"name": "MTo4MDhlZDUxYi1jOWYwLTQ5ODctYWU4My1lOWNlMzhkZjQ4ZTA=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo4MDhlZDUxYi1jOWYwLTQ5ODctYWU4My1lOWNlMzhkZjQ4ZTA=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.BatchDeleteFilesystemSnapshotsRequest",
			"filesystem": "fs1",
			"snapshots": [
				{
					"name": "globalSnap1"
				},
				{
					"name": "globalSnap2"
				}
			],
			"pit_continues_on_error": true
		},
		"status": "DONE",
		"request_time": "2025-04-04T05:10:05.591757217Z",
		"completion_time": "2025-04-04T05:10:06.126399946Z",
		"last_update_time": "2025-04-04T05:10:06.126399946Z",
		"output": "Invalidating snapshot files in :...",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.BatchDeleteSnapshotsResponse",
		"succeeded": [
			{
				"snap_name": "globalSnap1",
				"error": {
					"message": "Delete snapshot :globalSnap1 successful."
				}
			},
			{
				"snap_name": "globalSnap2",
				"error": {
					"message": "Delete snapshot :globalSnap2 successful."
				}
			}
		]
	}
}