Fetches the children of a directory

get

https://cluster.ip.address/v2/data-protect/recoveries/directories

Privileges: RESTORE_VIEW

Retrieves the immediate files and subdirectories of a specified directory within a VM, View, NAS Volume, Physical machine etc. i.e. any adapter that supports browse functionality

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to create a download files and folder recovery.

attemptNum

int64 | null

AttemptNum is the attempt number of the run that successfully created the snapshot.

browseIndexedData

boolean | null

Specifies whether to use indexed data for browse.

string | null

Cookie is used for paginating results. If the response returned partial results, it will also return a cookie that can be used to resume the listing. The value returned in response should be passed in the next call. The first call should not have this value set. Note that this value is only a suggestion and server is free to do a short read (return fewer entries along with a cookie). Please note that this should be used when browsing indexed data and does not apply otherwise.

dirPath

string

required

DirPath is the full path of the directory whose contents need to be listed.

environment

string | null

enum

Specifies the environment.

includeStatFileEntries

boolean | null

Defaults to false

Specifies whether file stat data is returned.

maxEntries

int32 | null

MaxEntries is the maximum number of entries to return in this call. If there are more entries, server will return a cookie in the response that can be used to continue enumeration from the last call. The default value is 1000 i.e. If no value is specified, 1000 entries are returned.

pointInTimeUsecs

int64 | null

PointInTimeUsecs is the time to read directory from previously available snapshot before this time.

snapshotId

string | null

Specifies the snapshot that we are checking for the directories

storageDomainId

int64 | null

Id of the Storage Domain if a View is being browsed.

viewName

string | null

Name of the View if a View is being browsed.

volumeInfoCookie

uint64 | null

VolumeInfoCookie is the cookie to be passed in calls to reading a directory for this volume.

volumeName

string | null

VolumeName is the name of the volume that needs to be browsed. This should match the name returned in VolumeInfo.

Responses

200Success

defaultError