Get file(s) or folder info

Get file(s) or folder info

Retrieves information about a specific file, a folder, or several files.

Scenario 1: Get a Single File

  • Use format=base64 if you want to download the actual file content.
  • Do not use filter or isRecursive.

Scenario 2: Get Several Files

  • Use filter to specify what to retrieve (e.g., * for everything, *.png for images).
  • Use isRecursive=true if you want to include subfolders.
  • Do not use format.

Scenario 3: Get Folder Information

  • Do not use format or filter.
Path Parameters
  • filePath
    string
    required

    The path relative to the root (...resources/Storage/). Encode forward slashes in path - use %2F instead of /.

    • For a single file, specify the full file path with its extension.
    • For several files or folder information, specify the folder path.
Query Parameters
  • format
    string

    [Single File Only] Allowed value: base64. Use it to include the actual file content in the response. Do not use this parameter when querying a folder or several files.

  • filter
    string

    [Several Files Only] File name mask to filter the results. Use * to get all files, or specify an extension like *.png.

  • isRecursive
    boolean

    [Several Files Only] Whether to return files from all nested subfolders recursively.

Responses
GET/storage/{filePath}
# Scenario 1: Get a Single File
curl --location -g --request GET 'https://{portal-url}/api/v2/storage/project-deep-space-exploration/info.png?format=base64'

# Scenario 2: Get Several Files
curl --location -g --request GET 'https://{portal-url}/api/v2/storage/project-deep-space-exploration?filter=*&isRecursive=false'

# Scenario 3: Get Folder Information
curl --location -g --request GET 'https://{portal-url}/api/v2/storage/project-deep-space-exploration/images'


{
  "fileName": "info.png",
  "fileFullName": "Storage\\project-deep-space-exploration\\info.png",
  "content": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAQklEQVQ4y2P0av/xn4ECwMRAIcBrwNYKdoatFey0dQELPknvjp/kG4DsdHwGMVFiO+1jYdQACg1ATgf4kjPLgKcDAL8dECIPWD7kAAAAAElFTkSuQmCC",
  "modifiedBy": "katherine",
  "modifiedOn": "2021-04-07T15:50:15",
  "size": 123,
  "isFolder": false
}