Skip to main content

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:

    FieldFilter ConditionDescription
    asset_type$eqRequired. The type of the asset within which to search for files. Possible values include aws_ebs_volume and aws_ec2_instance.
    asset_id$eqRequired. The Clumio-assigned ID of the asset within which to search for files.
    name$regexA 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

Success


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.

GET /backups/files/search    

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
filter — query required
limit — query
start — query
curl -L -X GET 'https://us-west-2.api.clumio.com/backups/files/search' \
-H 'Accept: application/api.clumio.backups-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>'