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

Files

Introduction

The Files endpoints return stored content, short-lived content URLs, and directory archives for FilemanagerFiles and FilemanagerDirectories.

Use the content URLs returned by the API instead of constructing encoded storage paths manually. Access is checked against the resolved file or directory. SharedItems provide access-controlled links when content must be shared beyond its regular assignments.

Show Content by Encoded Path

Show file content addressed by an encoded path.

Definition

GET /api/files/{path}

Route Parameters

Parameter
Type
Description

path

string

Encoded storage directory followed by the URL-encoded filename.

Behavior

  • The response streams the stored content or redirects to a temporary storage URL, depending on the configured filesystem.

  • Content-Type and Content-Disposition are derived from the stored file and resolved filename.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/files/jR8mK4/path-preview.txt', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

Create Temporary Content URL

Create a temporary URL for file content addressed by an encoded path.

Definition

GET /api/temp/files/{path}

Route Parameters

Parameter
Type
Description

path

string

Encoded storage directory followed by the URL-encoded filename.

Behavior

The returned storage URL is URL-encoded and expires after 10 seconds. It is intended for short-lived handoff to third-party viewers.

Example Request

Example Response

Download Directory

Download one FilemanagerDirectory as an archive.

Definition

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

Route Parameters

Parameter
Type
Description

filemanagerDirectory

integer or hash

Request Keys

Key
Type
Default
Description

filter

object

No filters

Filters applied to recursively selected files.

sort

string

Repository default

File ordering used while building the archive.

limit

integer

No limit

Maximum number of files included in the archive.

Behavior

The endpoint streams a ZIP archive. Only files visible to the current user and matching the supplied result controls are included.

Example Request

Example Response

Last updated