Skip to content

API Reference

This page documents all available API endpoints.

GET /?action=files

Get list of files from source.

Parameters: - action (required) - action name ("files") - source (optional) - source name - path (optional) - path within source (default: "/") - mods (optional) - modifiers ("withFolders" to include folders)

Examples:

# Get all files from "test" source
curl "http://localhost:8081/?action=files&source=test"

# Get files with folders
curl "http://localhost:8081/?action=files&source=test&mods=withFolders"

# Get files from subfolder
curl "http://localhost:8081/?action=files&source=test&path=/subfolder"

Response:

{
  "success": true,
  "data": {
    "code": 220,
    "sources": [
      {
        "name": "test",
        "title": "Test Files",
        "baseurl": "http://localhost:8081/files/test/",
        "path": "/",
        "files": [
          {
            "file": "image.png",
            "name": "image.png",
            "type": "file",
            "size": 1024,
            "changed": "2025-01-01T00:00:00.000Z",
            "isImage": true
          }
        ]
      }
    ]
  }
}

GET /ping

Health check endpoint.

Response:

{
  "success": true
}

POST /?action=fileUpload

Upload one or more files.

Parameters: - action (required) - action name ("fileUpload") - source (optional) - source name - path (optional) - destination path within source

Body: - Multipart form data with file(s)

POST /?action=fileUploadRemote

Upload file from remote URL.

Parameters: - action (required) - action name ("fileUploadRemote") - source (optional) - source name - path (optional) - destination path - url (required) - remote file URL

POST /?action=fileRemove

Remove one or more files.

Parameters: - action (required) - action name ("fileRemove") - source (optional) - source name - path (optional) - path within source - name (required) - file name or array of file names

POST /?action=fileMove

Move files to another location.

Parameters: - action (required) - action name ("fileMove") - source (optional) - source name - path (optional) - source path - dest (required) - destination path - name (required) - file name or array of file names

POST /?action=fileRename

Rename a file.

Parameters: - action (required) - action name ("fileRename") - source (optional) - source name - path (optional) - path within source - name (required) - current file name - newname (required) - new file name

POST /?action=folderCreate

Create a new folder.

Parameters: - action (required) - action name ("folderCreate") - source (optional) - source name - path (optional) - parent path - name (required) - folder name

POST /?action=folderRemove

Remove a folder.

Parameters: - action (required) - action name ("folderRemove") - source (optional) - source name - path (optional) - parent path - name (required) - folder name

POST /?action=folderMove

Move a folder.

Parameters: - action (required) - action name ("folderMove") - source (optional) - source name - path (optional) - source path - dest (required) - destination path - name (required) - folder name

POST /?action=folderRename

Rename a folder.

Parameters: - action (required) - action name ("folderRename") - source (optional) - source name - path (optional) - parent path - name (required) - current folder name - newname (required) - new folder name

GET /?action=folders

Get folder tree.

Parameters: - action (required) - action name ("folders") - source (optional) - source name - path (optional) - starting path

GET /?action=permissions

Get current user permissions.

Parameters: - action (required) - action name ("permissions")

POST /?action=imageResize

Resize an image.

Parameters: - action (required) - action name ("imageResize") - source (optional) - source name - path (optional) - path within source - name (required) - image file name - newname (optional) - new file name (default: overwrites original) - box (required) - width and height (e.g., "800,600")

POST /?action=imageCrop

Crop an image.

Parameters: - action (required) - action name ("imageCrop") - source (optional) - source name - path (optional) - path within source - name (required) - image file name - newname (optional) - new file name (default: overwrites original) - box (required) - crop coordinates "x,y,width,height"

POST /?action=generatePdf

Generate PDF from HTML content.

Parameters: - action (required) - action name ("generatePdf") - html (required) - HTML content to convert

POST /?action=generateDocx

Generate DOCX from HTML content.

Parameters: - action (required) - action name ("generateDocx") - html (required) - HTML content to convert

OpenAPI Specification

Complete OpenAPI specification is available at:

Next Steps