Skip to content

File API

Upload and download files, attach them to records, manage folders and create public share links.

Version

Service: File service
Base path: https://your-files-host/api/v1
Authentication: Bearer token and context headers. Public share links need no token.

POST/api/v1/FileManager/FileOperations

File manager operations

Read, create folder, rename, move, copy, delete, search and details, using the file-manager protocol the platform's file component speaks.

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/FileManager/Upload

Upload files

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/FileManager/Download

Download files

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/FileManager/GetImage

Get an image or its thumbnail

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/links

Create a share link

Links carry an expiry and an optional click limit. Only a hash of the token is stored.

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

DELETE/api/v1/links/{linkId}

Revoke a share link

Authentication: Bearer token and context headers
Permissions: Your role's access to the resource

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/l/{appId}/{environmentId}/{tenantId}/{userId}/{token}

Open a public share link

Every access is recorded.

Authentication: None (public)
Permissions: None

Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.