/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset_name}: DELETE

Deletes the fileset for the specified name.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/{filesystem}/filesets/{fileset_name} request deletes an existing fileset. 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/{fileset_name} resource. When deleting a fileset, consider the following conditions:

You can delete the root fileset
A fileset that is not empty cannot be deleted unless you specify the -f flag.
Note: If you use the -f flag, remove all NFS exports defined on or inside the fileset junction path before deleting it. Otherwise, you might encounter errors or issues when creating new filesets and exports.
You cannot delete a fileset that is linked to a namespace until you unlink it using the unlink request.
You can delete a dependent fileset at any time.
You cannot delete an independent fileset if it has dependent filesets or snapshots.
A deleted dependent fileset remains in the file system in a deleted state until the last snapshot that includes it is deleted.
Deleting an independent fileset that is included in a global snapshot removes it from the active file system, but it remains part of the file system in a deleted state.
The contents of a deleted fileset are still available in the snapshot through a path containing a .snapshots component because this data was saved when the snapshot was created.
When the last snapshot that includes the fileset is deleted, the fileset is fully removed from the file system.

Request URL

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

where

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

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_name	The name of the fileset.	Required.
force	Force delete the fileset. All fileset contents are deleted and any child filesets are first unlinked.	Optional.
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.
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.
```
{}
```

default: An unexpected error response.

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

Examples

The following example deletes a fileset:

Request data:

curl -X 'DELETE' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs0/filesets/test-fileset' \
  -H 'accept: application/json' \
  -n -k

Response data:

{
        "name": "MTo1OWRhNDcyZi1lYWIyLTQwN2EtOTdmYy02OGY0Y2MyODI2ZTg=",
        "metadata": {
                "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
                "job_id": "MTo1OWRhNDcyZi1lYWIyLTQwN2EtOTdmYy02OGY0Y2MyODI2ZTg=",
                "operation_details": {
                        "@type": "type.googleapis.com/fileset.v3.DeleteFilesetRequest",
                        "filesystem": "fs0",
                        "fileset_name": "test-fileset"
                },
                "status": "DONE",
                "request_time": "2025-04-14T19:37:46.582749858Z",
                "completion_time": "2025-04-14T19:37:46.718764029Z",
                "last_update_time": "2025-04-14T19:37:46.718764029Z",
                "domain_ids": [
                        0
                ]
        },
        "done": true,
        "response": {
                "@type": "type.googleapis.com/fileset.v3.DeleteFilesetResponse"
        }
}