Retrieve an asset's filesystem

Returns a representation of the specified filesystem.

Path Parameters

filesystem_id string required
Performs the operation on the filesystem with the specified ID.
backup_id string required
Performs the operation on a filesystem within the specified backup.

Responses

200
default

Success

application/api.clumio.backup-filesystems=v1+json

Schema
Example (from schema)

Schema

_links object
HateoasCommonLinks are the common fields for HATEOAS response.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
available uint64
The amount of available memory on the filesystem in bytes. Does not include reserved memory.
filesystem_native_id string
The filesystem UUID produced by the lsblk linux command. If this filesystem was not given a UUID in the host environment, then this field has a value of null.
id string
The Clumio-assigned ID of the filesystem.
indexing_failed_reason string
The reason why file indexing failed. If file indexing succeeded, then this field has a value of null. Possible values include "unsupported" and "encrypted".
is_encrypted boolean
Determines whether the file system was encrypted.
is_indexed boolean
Determines whether the file system has been indexed. If true, file indexing completed successfully.
mount_path string
The location of this filesystem in the host environment. Only identifies mount points that correspond to Windows drive letters. All other mount points are identified by a '/'.
num_files_indexed int64
The number of files (including directories) indexed in the file system.
size uint64
The total amount of memory available to the filesystem in bytes.
type string
The type of the filesystem. This field is populated with values returned from the lsblk command. Possible values include ntfs, xfs, and ext3.
used uint64
The amount of memory used by the filesystem in bytes.

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "available": 0,
  "filesystem_native_id": "string",
  "id": "string",
  "indexing_failed_reason": "string",
  "is_encrypted": true,
  "is_indexed": true,
  "mount_path": "string",
  "num_files_indexed": 0,
  "size": 0,
  "type": "string",
  "used": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /backups/:backup_id/filesystems/:filesystem_id

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

filesystem_id — path required

backup_id — path required

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/backups/:backup_id/filesystems/:filesystem_id' \
-H 'Accept: application/api.clumio.backup-filesystems=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

Retrieve an asset's filesystem​

Authorization

Request

Retrieve an asset's filesystem