Skip to main content

Retrieve a list of files and folders

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/sfr/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot/{snapshotId}/file-explore/list

Retrieves a list of files and folders within a specified volume snapshot in a paginated format during a file or folder restore operation (V2 version of the file-explore/list API). You can pass the number of pages and limit of the number of files that the API endpoint should retrieve while fetching the details in a paginated format. The volume snapshot is mounted on under the /tmp folder of the Console agent instance to create a file catalog for the "Browse and Restore" option.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

snapshotLocation

string

query

False

Location of the snapshot

  • enum: ["LOCAL", "CLOUD"]

fileType

string

query

False

Type of the file

  • enum: ["FILE", "DIRECTORY", "ALL"]

sortBy

string

query

False

The column name to sort with

  • enum: ["name", "size", "mtime"]

orderBy

string

query

False

Order of the results, either ASCENDING or DESCENDING

  • enum: ["ASC", "DESC"]

name

string

query

False

Name of the file or directory

path

string

query

False

Path of files to browse

page

number

query

False

Number of the page

limit

number

query

False

Limit of files

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

System ID

volumeId

string

path

True

File system ID/Volume ID

snapshotId

string

path

True

Snapshot ID

authorization

string

header

True

User token

X-Agent-Id

string

header

True

Request identifier

Response

Status: 200, Default response
Name Type Required Description

pageConfig

pageConfig

False

context

array[context]

False
Example response 
{
  "context": [
    {
      "inode": "string",
      "name": "string",
      "path": "string",
      "type": "string"
    }
  ]
}

Definitions

See Definitions
Name Type Required Description

page

number

False

Next page number

limit

number

False

Limit of files
Name Type Required Description

page

number

False

Previous page number

limit

number

False

Limit of files

pageConfig

Name Type Required Description

next

next

False

previous

previous

False

startIndex

number

False

Starting index of file list

endIndex

number

False

Ending index of file list

context

Name Type Required Description

inode

string

False

name

string

False

path

string

False

type

string

False

size

number

False

mtime

number

False