External DocumentationTo learn more, visit the Veeam Basic Backup & Replication documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Event Type | The type of malware event to filter by. |
| ID | The ID to filter the repository states by. |
| Limit | The number of items to return. |
| Name | Filters results based on a name pattern. Supports wildcard matching using * at the start and/or end to replace one or more characters. |
| Offset | The offset of the results. |
| Order Column | The column to sort the results by. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort Order | Determine whether the results are sorted in ascending or descending order. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Capacity | The capacity value to filter the repository states by. |
| Exclude Extents | Select to filter out the repositories that are part of an extent for SOBR from the result. |
| Free Space | The free space value to filter the repository states by. |
| Online Status | Select to only retrieve online repositories. |
| Out Of Date Status | Select to only retrieve repositories that are out of date. |
| SOBR Extent Type | The repository extent type of the SOBR to filter the repository states by. |
| SOBR ID | The SOBR ID to filter the repository states by. |
| SOBR Membership | The repository membership of the SOBR to filter the repository states by. |
| Used Space | The used space value to filter the repository states by. |
Example Output
{
"data": [
{
"type": "WinLocal",
"id": "d4b5e196-f3ad-474c-99bc-dfef051dae07",
"name": "Backup Repository 1",
"description": "Created by TECH\\sheila.d.cory",
"hostId": "e22b8842-c454-4036-abd5-f468c3248aaf",
"hostName": "enterprise03.tech.local",
"path": "C:\\Backup Repository",
"capacityGB": 299.4,
"freeGB": 217.8,
"usedSpaceGB": 173.4,
"isOnline": true,
"isOutOfDate": false
},
{
"type": "WinLocal",
"id": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
"name": "Default Backup Repository",
"description": "Created by Veeam Backup",
"hostId": "6745a759-2205-4cd2-b172-8ec8f7e60ef8",
"hostName": "enterprise06.tech.local",
"path": "C:\\Backup",
"capacityGB": 99.4,
"freeGB": 16.4,
"usedSpaceGB": 30.4,
"isOnline": true,
"isOutOfDate": true
}
],
"pagination": {
"total": 2,
"count": 2,
"skip": 0,
"limit": 200
}
}