Logo Dolphin Storage

Storage API

Browser File

Browser File API is used to view folder structure for a specific path in one store.

Endpoint

GET

HEADER

x-api-key: API key generated in your account.

PATH PARAMETERS

storeSlug: slug of the target store.

path: path to a folder or file, for example /animal/dolphin.png.

RESPONSE

success: boolean. Indicates whether the browser request is successful.

data: array. List of entries returned for the requested path.

Fields inside each item of data[]:

name: string. File or folder name.

path: string. Full path to the file or folder.

kind: string. Entry type, either file or folder.

contentType: string. MIME type of the file. Can be empty for folder.

size: number. File size in bytes. Can be 0 for folder.

createdAt: string. Creation timestamp of the file or folder.

children: array. List of child entries if the entry is a folder. Can be empty for file.