Search files

Retrieve the list of files whose name matches a given regex pattern.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

filter string required

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
asset_type	$eq	Required. The type of the asset within which to search for files. Possible values include `aws_ebs_volume` and `aws_ec2_instance`.
asset_id	$eq	Required. The Clumio-assigned ID of the asset within which to search for files.
name	$regex	A regex pattern to match against file names. For example, `?filter={"name":{"$regex":"a(\\w){2,5}"}`

For more information about filtering, refer to the Filtering section of this guide.

Responses

200
default

Success

application/api.clumio.backups-files=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_links object
URLs to pages related to the resource.
list-file-versions object
A HATEOAS link to the file versions associated with 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.
path string
The full file path.
search_result_id string
The Clumio-assigned ID representing a collection of one or more versions of the same file backed up at different times. This ID cannot be used to restore the file. To restore the file, use the GET /backups/files/search/{search_result_id}/versions endpoint to retrieve particular versions of this file that can be restored. Then, use the backup ID, filesystem ID, and file path as parameters for the POST /restores/files endpoint.
_links object
URLs to pages related to the resource.
_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.
_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.
_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 token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "_links": {
          "list-file-versions": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "path": "string",
        "search_result_id": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string"
}

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"
    }
  ]
}

Search files​

Search files