/scalemgmt/v3/filesystems/{filesystem}/snapshots:snapdir: GET

Displays the current snapshot directory settings.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/snapshots:snapdir request gets the current snapshot directory settings.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/snapshots
where
{filesystem}
Specifies the filesystem 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.
X-StorageScaleDomain The domain to be authorized against for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 201: A successful response.
    {
  "fileset_snapdir": "string",
  "filesystem_name": "string",
  "global_snapdir": "string",
  "global_snapdir_type": "SNAPSHOTDIRTYPE_ALL_DIRS",
  "snapdir_type": "SNAPSHOTDIRTYPE_ALL_DIRS"
}
  • default: An unexpected error response.
    {
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example displays the current snapshot directory settings:

Request data: 
curl -X 'GET' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/snapshots:snapdir' -H 'accept: application/json' -n -k
Response data: 
{
	"filesystem_name": "fs1",
	"fileset_snapdir": ".snapshots",
	"snapdir_type": "SNAPSHOTDIRTYPE_ALL_DIRS",
	"global_snapdir": ".snapshots",
	"global_snapdir_type": "SNAPSHOTDIRTYPE_GLOBAL_ALL_FILESETS"
}