For the complete documentation index, see llms.txt. This page is also available as Markdown.

FilemanagerFiles

Introduction

FilemanagerFiles store metadata for files in Filemanager storage. Each file stores its nullable filemanager_directory_id, name, and normalized path; nested files belong to their direct FilemanagerDirectory, while root files use a null directory ID. Missing directory records are created when necessary during upload or movement.

Model Definition

Alias

filemanagerFile

Relations

Key
Relation
Type
Relation Field(s)

user

Belongs to

user_id

filemanagerDirectory

Belongs to

filemanager_directory_id

Computed Properties

  • hash - Hashed representation of the file id.

  • url and static_url - Link to the Filemanager metadata page.

  • show_file_content_url - Access-checked URL that displays the stored content.

  • download_file_content_url - Content URL with download disposition.

Capabilities

  • URL Context - Metadata and content URLs resolve to access-checked context containing filename, MIME type, extension, byte size, location, icon, and image preview information where available.

List

List files visible to the authenticated user.

Definition

GET /api/filemanager/files

Request Keys

Key
Type
Default
Description

filter

object

{}

Result Control filters, including Filemanager path filters.

sort

string

API default

Result Control sort expression.

appends

string

API default

Computed properties to append.

Behavior

  • File visibility is derived from the accessible directory path. Expensive relations are not included by list endpoints even when requested.

Example Request

Example Response

List by Path

List direct child files of a normalized directory path. Omitting path lists root files.

Definition

GET /api/filemanager/files/path/{path?}

Route Parameters

Parameter
Type
Description

path

string

Optional. Directory path. Defaults to /.

Request Keys

Key
Type
Default
Description

filter

object

{}

Optional Result Control filters.

sort

string

API default

Result Control sort expression.

Example Request

Example Response

List by Directory

List direct child files of one visible directory.

Definition

GET /api/filemanager/directories/{filemanagerDirectory}/files

Route Parameters

Parameter
Type
Description

filemanagerDirectory

integer | string

Directory ID or hash.

Request Keys

Key
Type
Default
Description

filter

object

{}

Optional Result Control filters applied to the direct children.

sort

string

API default

Result Control sort expression.

Behavior

  • The directory must be visible to the authenticated user. The response contains only its direct visible files.

Example Request

Example Response

Count

Count visible files after Result Control filters are applied.

Definition

GET /api/filemanager/files/count

Request Keys

Key
Type
Default
Description

filter

object

{}

Result Control filters applied before counting.

Example Request

Example Response

Show

Show one visible file.

Definition

GET /api/filemanager/files/{filemanagerFile}

Route Parameters

Parameter
Type
Description

filemanagerFile

integer | string

File ID or hash.

Example Request

Example Response

Show EXIF Data

Return normalized metadata for a JPEG, PNG, or TIFF file.

Definition

GET /api/filemanager/files/{filemanagerFile}/exif

Route Parameters

Parameter
Type
Description

filemanagerFile

integer | string

Image file ID or hash.

Behavior

  • Metadata is read from a bounded file prefix. Unsupported formats return an error; supported files without readable metadata return an empty object.

Example Request

Example Response

Create

Upload a file and create its metadata record.

Definition

POST /api/filemanager/files

Request Keys

Key
Type
Default
Description

file*

file

-

Uploaded file. Filename and content type determine extension and mime_type.

path*

string

-

Complete target path. Normalized with a leading slash.

filemanager_directory_id

integer | null

Derived from path

Direct target directory. When supplied, name builds the path.

name

string

Derived from path

Target filename when a directory ID is supplied.

Keys with * are required unless filemanager_directory_id and name provide the hierarchy.

Behavior

  • user_id is set to the authenticated user. Missing directory records in the supplied path are created before the file relation is resolved.

  • When filemanager_directory_id is present, it and name determine the hierarchy and take precedence over a conflicting path. A null directory ID creates a root file.

  • The upload fails when the tenant's configured available storage is insufficient.

Example Request

Example Response

Update

Replace file content, move the file, or rename it.

Definition

PUT /api/filemanager/files/{filemanagerFile}

Route Parameters

Parameter
Type
Description

filemanagerFile

integer | string

File ID or hash.

Request Keys

Key
Type
Description

file

file

Replacement content.

path

string

Complete target path.

filemanager_directory_id

integer | null

New direct directory.

name

string

New filename.

Behavior

  • user_id remains the authenticated user. The backend rebuilds path, name, and filemanager_directory_id as a consistent hierarchy.

  • When filemanager_directory_id or name is present, those hierarchy fields take precedence over a conflicting path; omitted hierarchy fields retain their current values. A null directory ID moves the file to the root.

  • Replacing content updates the extension, MIME type, and byte size. Moving or replacing a file regenerates its thumbnail or media poster where supported.

Example Request

Example Response

Delete

Delete the metadata record, stored content, and generated thumbnail.

Definition

DELETE /api/filemanager/files/{filemanagerFile}

Route Parameters

Parameter
Type
Description

filemanagerFile

integer | string

File ID or hash.

Example Request

Example Response

Last updated