/share_link

Shortens url paths and generates an url friendly share id to be accessed via /share/<share_id>.

• The creating user is stored alongside with the share link. If that user is archived the system user system:deleted_user.

• There is no API to revoke an existing share link.

• Share links are removed only after they expire.

POST /system/share_link

post

Create a new share link.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Body

application/json

pathstring · uri-referenceRequired

The URI path to shorten, must start with /.

Pattern: ^\/

expires_atstring · date-timeOptional

ISO date and time when the share link expires. Defaults to one year.

aliasstringOptional

Optional alias that can be used instead of the randomly generated short id to access the share link. Only charaters defined in RFC 3968 are allowed.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_~\.]*[a-zA-Z0-9]$

Responses

200

New share link entry

application/json

pathstring · uri-referenceRequired

The target path of the share link URL.

Pattern: ^\/

share_idstringRequired

The randomly generated id that is used to access the link via <external_url>/share/<share_id>.

Pattern: ^[a-zA-Z0-9]+$

aliasstringOptional

The user set alias to access the link via <external_url>/share/<alias>.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_~\.]*[a-zA-Z0-9]$

created_atstring · date-timeRequired

Timestamp when the short link was created.

expires_atstring · date-timeRequired

Timestamp when the short link expires.

400

The share link could not be created. The code field identifies the specific validation failure — invalid path, invalid alias, expiration in the past, or a collision with an existing link.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

{
  "path": "../folder",
  "share_id": "text",
  "alias": "text",
  "created_at": "2026-06-10T14:41:28.717Z",
  "expires_at": "2026-06-10T14:41:28.717Z"
}

GET /system/share_link/{id}

get

Redirect to url referenced by given id, if available

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

idstringRequired

Shortened hash or alias set by user

Responses

301

Successful redirect

400

No share link entry for the given id (or it has expired). The response carries code: ShareLinkInvalid.

application/json

No content