The Files REST API provides endpoints to access files in Haplo applications.

Enabling the Files API

Install the haplo_api_file_v0 plugin to enable access to the Files API.


A user can only access the API if they are in the “API v0: File” group (API code haplo:group:api-v0:file-api). In general, you should create an API key for the service user defined by the haplo_api_file_v0 plugin:

Your Name » System management » Users » SRV » API v0: File » New API key…

Set the request path to /api/v0-file/ for any API key you create.


Endpoint Method Action
/api/v0-file/metadata GET Metadata
/api/v0-file/tags GET & POST Tags

See Introduction for how to form a request URL.