Skip to main content

Retrieve Snapshot copies

Contributors

POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/catalog/snapshots

Retrieves a list of local and cloud Snapshot copies pertaining to a particular volume by using the catalog index query.

Token usage: BlueXP user token.

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

resourceName

string

True

workingEnvironmentId

string

True

volumeId

string

True

resourceType

string

True
Example request 
{
  "resourceName": "string",
  "workingEnvironmentId": "string",
  "volumeId": "string",
  "resourceType": "string"
}

Response

Status: 200, Default response
Name Type Required Description

results

results

False

endOfResults

boolean

False
Example response 
{
  "results": {
    "workingEnvironmentId": "string",
    "workingEnvironmentName": "string",
    "volumeName": "string",
    "volumeId": "string",
    "snapshots": [
      {
        "snapshotId": "string",
        "snapshotName": "string",
        "location": "string",
        "ransomware-scan-status-failure": "string",
        "object-lock": "string",
        "ransomware-scan-status": "string"
      }
    ]
  }
}

Definitions

See Definitions

body

Name Type Required Description

resourceName

string

True

workingEnvironmentId

string

True

volumeId

string

True

resourceType

string

True

snapshots

Name Type Required Description

snapshotId

string

False

snapshotName

string

False

snapshotSize

number

False

snapshotCreationTime

number

False

location

string

False

last-ransomware-scan

number

False

ransomware-scan-status-failure

string

False

object-lock

string

False

ransomware-scan-status

string

False

archived

boolean

False

results

Name Type Required Description

workingEnvironmentId

string

False

workingEnvironmentName

string

False

volumeName

string

False

volumeId

string

False

snapshots

array[snapshots]

False