Retrieve snapshot information for a volume
Retrieves snapshot information for a volume backed up using NetApp Backup and Recovery. Use this to view details such as snapshot name, creation time, archive status, and ransomware scan status.
HTTP method and endpoint
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/snapshot
Token usage
NetApp Console user token.
Usage notes
Retrieves snapshot information for a specified volume backed up using NetApp Backup and Recovery for a system. This API endpoint retrieves the details of the volume snapshots from the NetApp Console SaaS application. It retrieves the snapshot name, snapshot creation time, archive status, and size. It also retrieves the object-lock, ransomware-scan-status-failure, and ransomware-scan-status details.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
svm |
string |
query |
False |
SVM names in comma separated values |
accountId |
string |
path |
True |
Account ID |
workingEnvironmentId |
string |
path |
True |
System ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Response
Status: 200, Default response
| Name | Type | Required | Description |
|---|---|---|---|
snapshot |
array[snapshot] |
False |
Example response
{
"snapshot": [
{
"id": "string",
"name": "string",
"object-lock": "string",
"ransomware-scan-status-failure": "string",
"ransomware-scan-status": "string",
"volume-id": "string",
"volume-name": "string",
"working-environment-id": "string",
"working-environment-name": "string",
"svm": "string"
}
]
}
Definitions
See Definitions
snapshot
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
|
name |
string |
False |
|
creation-time |
number |
False |
|
size |
number |
False |
|
last-ransomware-scan |
number |
False |
|
object-lock |
string |
False |
|
ransomware-scan-status-failure |
string |
False |
|
archived |
boolean |
False |
|
ransomware-scan-status |
string |
False |
|
volume-id |
string |
False |
|
volume-name |
string |
False |
|
working-environment-id |
string |
False |
|
working-environment-name |
string |
False |
|
svm |
string |
False |