Search for a specific file (on premises)
Suggest changes
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/search/job
Searches for a specific file from the backups taken by the NetApp Backup and Recovery service across on-premises volumes and systems. It can also search for a specified volume. It is possible to narrow down your file search based on a particular system, file extensions, size ranges, creation date range, and also location of a backup.
Token usage:NetApp Console user token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
query |
string |
query |
True |
|
jobId |
string |
query |
False |
|
accountId |
string |
path |
True |
|
authorization |
string |
header |
True |
|
X-Agent-Id |
string |
header |
True |
Response
Status: 200, Default response| Name | Type | Required | Description |
|---|---|---|---|
results |
array[results] |
False |
|
endOfResults |
boolean |
False |
|
status |
string |
False |
|
message |
string |
False |
|
job-id |
string |
False |
Example response
{
"results": [
{
"resourceName": "string",
"resourceType": "string",
"workingEnvironmentId": "string",
"workingEnvironmentName": "string",
"svmName": "string",
"volumeId": "string",
"volumeName": "string",
"inode": "string"
}
],
"status": "string",
"message": "string",
"job-id": "string"
}Definitions
See Definitions
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 |
string |
False |
|
mtime |
number |
False |
|
latestSnapshotCreationTime |
number |
False |
|
snapshotsCount |
number |
False |