Search files

get https://{region}.api.clumio.com/backups/files/search

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

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

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`, `aws_ec2_instance`, and `vmware_vm`.
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

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_links

object

URLs to pages related to the resource.

path

string

required

The full file path.

search_result_id

string

required

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.

_next

object

The HATEOAS link to the next page of results.

_self

object

The HATEOAS link to this resource.

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.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/backups/files/search \
3
     --header 'accept: application/api.clumio.backups-files=v1+json'


xxxxxxxxxx
37
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_links": {
6
          "list-file-versions": {
7
            "href": "string",
8
            "templated": true,
9
            "type": "string"
10
          }
11
        },
12
        "path": "string",
13
        "search_result_id": "string"
14
      }
15
    ]
16
  },
17
  "_links": {
18
    "_first": {
19
      "href": "string",
20
      "templated": true,
21
      "type": "string"
22
    },
23
    "_next": {
24
      "href": "string",
25
      "templated": true,

200200 HTTP success response

defaultError