Search a specific file
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search
Searches for a specific file from the backups taken by BlueXP backup and recovery across volumes and working-environments. It can also search for a specified volume. It is possible to narrow down your file search based on a particular working environment, file extensions, size ranges, creation date range, and also location of a backup.
Token usage:BlueXP user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
query |
string |
query |
True |
Search sting |
accountId |
string |
path |
True |
Account ID |
authorization |
string |
header |
True |
User token |
x-agent-id |
string |
header |
True |
Request identifier |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
type |
string |
False |
Type of resource file/volume |
workingEnvironmentId |
array[string] |
False |
|
fileExtension |
array[string] |
False |
File extension |
size |
False |
Resource size in bytes |
|
creationDate |
False |
Creation date in milliseconds |
|
backupLocation |
string |
False |
Snapshot location local/cloud |
Example request
{
"type": "string",
"workingEnvironmentId": [
"string"
],
"fileExtension": [
"string"
],
"backupLocation": "string"
}Response
Status: 200, Default response| Name | Type | Required | Description |
|---|---|---|---|
results |
array[results] |
False |
|
endOfResults |
boolean |
False |
Example response
{
"results": [
{
"resourceName": "string",
"resourceType": "string",
"workingEnvironmentId": "string",
"workingEnvironmentName": "string",
"svmName": "string",
"volumeId": "string",
"volumeName": "string"
}
]
}Definitions
See Definitions
size
Resource size in bytes
| Name | Type | Required | Description |
|---|---|---|---|
from |
number |
False |
|
to |
number |
False |
creationDate
Creation date in milliseconds
| Name | Type | Required | Description |
|---|---|---|---|
from |
number |
False |
|
to |
number |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
type |
string |
False |
Type of resource file/volume |
workingEnvironmentId |
array[string] |
False |
|
fileExtension |
array[string] |
False |
File extension |
size |
False |
Resource size in bytes |
|
creationDate |
False |
Creation date in milliseconds |
|
backupLocation |
string |
False |
Snapshot location local/cloud |
results
| Name | Type | Required | Description |
|---|---|---|---|
resourceName |
string |
False |
|
resourceType |
string |
False |
|
workingEnvironmentId |
string |
False |
|
workingEnvironmentName |
string |
False |
|
svmName |
string |
False |
|
volumeId |
string |
False |
|
volumeName |
string |
False |
|
resourceSize |
number |
False |
|
inode |
number |
False |
|
mtime |
number |
False |
|
latestSnapshotCreationTime |
number |
False |
|
snapshotsCount |
number |
False |