Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[limit]
integer
default:20

The number of filesystems to return per page. Values above 250 are treated as 250.

Required range: 1 <= x <= 250
page[after]
string

Opaque cursor from a previous response's meta.cursors.after; returns the page after it. Mutually exclusive with page[before].

page[before]
string

Opaque cursor from a previous response's meta.cursors.before; returns the page before it. Mutually exclusive with page[after].

filter[name]
string

Return only the filesystem whose name matches exactly.

filter[status]
enum<string>

Return only filesystems with this status. Unrecognized values are ignored.

Available options:
provisioning,
ready,
needs_format,
deleting,
failed
filter[region]
string

Return only filesystems in this region.

Example:

"us-east-1"

sort
enum<string>
default:-created_at

Sort order for the results: a field name for ascending, or the field name prefixed with - for descending.

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
name,
-name

Response

CloudFS filesystems retrieved successfully

data
object[]
meta
object