Generate an inventory report
Suggest changes
POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/report
Generates an inventory report. You can create the inventory report for the whole account or a specific list of systems. It is also possible to generate reports for storage VMs under a system. By setting the "inventory-type" as "BACKUP", you can create a report for the backup actions. By setting it as "ALL", you can create a report for all the actions.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
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 |
|---|---|---|---|
inventory-type |
string |
False |
|
protection-type |
string |
False |
|
returnSnapshots |
boolean |
False |
|
filters |
array[filters] |
False |
Example request
{
"inventory-type": "string",
"protection-type": "string",
"filters": [
{
"working-environment-id": "string",
"svm": [
"string"
]
}
]
}Response
Status: 202, Default response| Name | Type | Required | Description |
|---|---|---|---|
job-id |
string |
False |
Example response
{
"job-id": "string"
}Definitions
See Definitions
filters
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
False |
|
svm |
array[string] |
False |
body
| Name | Type | Required | Description |
|---|---|---|---|
inventory-type |
string |
False |
|
protection-type |
string |
False |
|
returnSnapshots |
boolean |
False |
|
filters |
array[filters] |
False |