/scalemgmt/v3/filesystems/remote/{filesystem}: DELETE

Deletes a remote file system.

Availability

Available on all IBM Storage Scale editions.

Description

The DELETE filesystems/remote/{filesystem} request deletes a remote file system.

Request URL

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

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.
permanently_damaged	Indicates that the remote file system is permanently damaged and that deletion should 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.
```
{}
```

default: An unexpected error response.

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

Examples

The following example deletes a remote file system:

Request data:

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

Response data:

{}