List filesystems

Returns a list of filesystems.

Path Parameters

backup_id string required
The Clumio assigned ID of the backup to retrieve.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

Responses

200
default

Success

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

Schema
Example (from schema)

Schema

_embedded object
_embedded contains the list of items of a file_system list query
items object[]
items denotes the list of file_system instances in the current scope.
_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 object
_links provides URLs to related navigable pages of a file_system list query
_first object
The HATEOAS link to the first page of results.
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.
_last object
The HATEOAS link to the last page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_prev object
The HATEOAS link to the previous page of results.
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.
_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.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

{
  "_embedded": {
    "items": [
      {
        "_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
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 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

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

backup_id — path required

limit — query

start — query

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

List filesystems​

Authorization

Request

List filesystems