Skip to main content

Retrieve Snapshot copy information

Contributors

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

Retrieves Snapshot copy information for a specified volume backed up by using BlueXP backup and recovery for a working environment. This API endpoint retrieves the details of the volume Snapshot copies from the BlueXP 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.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

workingEnvironmentId

string

path

True

volumeId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

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"
    }
  ]
}

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