Endpoints

The fylr HTTP/JSON API. Most endpoints live under the /api/v1 base path — for example /api/v1/collection or /api/v1/search. The OAuth2 / OpenID Connect endpoints under /api/oauth2 and the .well-known discovery document are the exceptions; each lists its own full path.

Authentication. Calls are authenticated with an access token. Present it as an Authorization: Bearer <token> header, or — as fallbacks — the access_token query parameter or an X-Fylr-Authorization: Bearer <token> header (a workaround for Safari, which overwrites Authorization). A request without a valid token runs as an anonymous session; endpoints that require a user then answer 401.

Each page below documents one endpoint group, with an interactive panel per operation generated from the OpenAPI specification (fylr-openapi.yml). Pages are grouped by the first path segment; larger groups — collection, eas, system, config, plugin — carry subpages. The /api/v1 groups are listed alphabetically; the endpoints that live outside /api/v1 — /api/oauth2, /.well-known and /inspect — follow at the end.

All endpoints

• /api/v1/collection

• /api/v1/config

• /api/v1/db

• /api/v1/db_info

• /api/v1/eas

• /api/v1/event

• /api/v1/export

• /api/v1/group

• /api/v1/hotfolder

• /api/v1/l10n

• /api/v1/mask

• /api/v1/message

• /api/v1/oai

• /api/v1/objects

• /api/v1/objecttype

• /api/v1/plugin

• /api/v1/pool

• /api/v1/publish

• /api/v1/right

• /api/v1/schema

• /api/v1/search

• /api/v1/settings

• /api/v1/suggest

• /api/v1/system

• /api/v1/tags

• /api/v1/task

• /api/v1/transitions

• /api/v1/user

• /api/v1/WebDAV

• /api/v1/xmlmapping

• /api/oauth2

• /.well-known

• /inspect