Retrieve snapshot information for a volume

09/25/2026

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot

Retrieves snapshot information for a specified volume backed up using the NetApp Backup and Recovery service 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.

Token usage: NetApp Console user token.

Parameters

Name	Type	In	Required	Description
accountId	string	path	True	Account ID
workingEnvironmentId	string	path	True	System ID
volumeId	string	path	True	File system or volume ID
include-indexing-status	boolean	query	False	Include the field named indexing-status on each snapshot in the response
authorization	string	header	True	User token
X-Agent-Id	string	header	True	Request identifier

Name

Type

Required

Description

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

System ID

volumeId

string

path

True

File system or volume ID

include-indexing-status

boolean

query

False

Include the field named indexing-status on each snapshot in the response

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

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",
      "indexing-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
indexing-status	string	False	Indicates whether the snapshot has been indexed by the Indexed Catalog. Returned only for catalogs running version 2 indexing, and only when the name of the volume is known. NOT_INDEXED is returned for a snapshot that the catalog does not account for, or if the catalog cannot be reached.
volume-id	string	False
volume-name	string	False
working-environment-id	string	False
working-environment-name	string	False
svm	string	False

Name

Type

Required

Description

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

indexing-status

string

False

Indicates whether the snapshot has been indexed by the Indexed Catalog. Returned only for catalogs running version 2 indexing, and only when the name of the volume is known. NOT_INDEXED is returned for a snapshot that the catalog does not account for, or if the catalog cannot be reached.

volume-id

string

False

volume-name

string

False

working-environment-id

string

False

working-environment-name

string

False

svm

string

False