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:
For more information about filtering, refer to the Filtering section of this guide.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
andaws_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}"}
Responses
- 200
- default
Success
- application/api.clumio.backups-files=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /backups/files/search
Authorization
Request
Request
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>'
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>'
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>'
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>'
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>'
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>'
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>'