Skip to main content

Retrieve a list of files and folders

Contributors

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 copy in a paginated fashion 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 copy is mounted on under the /tmp folder of the Connector instance to create a file catalog for the "Browse and Restore" option.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

path

string

query

False

page

number

query

False

limit

number

query

False

accountId

string

path

True

workingEnvironmentId

string

path

True

volumeId

string

path

True

snapshotId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

pageConfig

pageConfig

False

context

array[context]

False

Example response
{
  "context": [
    {
      "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

number

False

name

string

False

path

string

False

type

string

False

size

number

False

mtime

number

False