/scalemgmt/v3/filesystems/{name}: DELETE

Deletes an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/{name} request removes all the structures for the IBM Storage Scale file system from the nodes in the cluster. You must unmount the file system before deleting it by using the mmdelfs request. Use the --permanently-damaged flag to force the removal of a file system from the cluster data if the file system disks cannot be marked as available. 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/{name} resource.

Request URL

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

where

filesystems/{name}: Specifies the IBM Storage Scale cluster as the target of the DELETE 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
name	The name of the file system.	Required.
permanently_damaged	Indicates that disks are permanently damaged and file system deletion need to proceed regardless.	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 additional content was sent.
```
{}
```
202: The request has been accepted for processing, but the processing has not been completed.
```
{}
```

Examples

The following example deletes the fs1 file system:

Request data:

curl -X 'DELETE' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1?permanently_damaged=false' \
  -H 'accept: application/json' -k -n

Response data:

{
	"name": "MTowOTZjOTFhNy0zZWU1LTRhM2UtOGZlZi05OWU3M2U5Y2IxMjk=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTowOTZjOTFhNy0zZWU1LTRhM2UtOGZlZi05OWU3M2U5Y2IxMjk=",
		"operation_details": {
			"@type": "type.googleapis.com/filesystem.v3.DeleteFilesystemRequest",
			"name": "fs1"
		},
		"status": "DONE",
		"request_time": "2025-03-31T21:15:46.370247903Z",
		"completion_time": "2025-03-31T21:15:47.278460379Z",
		"last_update_time": "2025-03-31T21:15:47.278460379Z",
		"output": "All data on the following disks ...",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/filesystem.v3.DeleteFilesystemResponse"
	}
}