/api/v1/plugin

Read information about installed plugins, and download the bundled plugin assets (JavaScript, CSS, HTML templates, translations).

GET /plugin — List installed plugins.

List installed plugins.

get

Returns the descriptors of all enabled plugins (disabled plugins are not exposed here) and — when bundling is enabled on the instance — the URLs of the concatenated front-end asset bundles.

This endpoint is public: no access token is required.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Responses

200

The plugin inventory and the front-end bundle URLs.

application/json

Response of GET /plugin — the inventory of enabled plugins plus the URLs of their concatenated front-end bundles.

200

The plugin inventory and the front-end bundle URLs.

{
  "plugins": [],
  "bundle": {
    "javascript": "https://example.fylr.io/api/v1/plugin/bundle.js",
    "css": "https://example.fylr.io/api/v1/plugin/bundle.css",
    "html": "https://example.fylr.io/api/v1/plugin/bundle.html",
    "l10n": "https://example.fylr.io/api/v1/plugin/bundle/l10n"
  }
}

GET /plugin/bundle.js — Concatenated plugin JavaScript bundle.

Concatenated plugin JavaScript bundle.

get

Returns the JavaScript bundle of every enabled plugin, in load-order. Cached client-side using the standard fylr cache-id header.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Responses

200

The JavaScript bundle.

text/javascript

stringOptional

200

The JavaScript bundle.

text

GET /plugin/bundle.css — Concatenated plugin CSS bundle.

Concatenated plugin CSS bundle.

get

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Responses

200

The CSS bundle.

text/css

stringOptional

200

The CSS bundle.

text

GET /plugin/bundle.html — Concatenated plugin HTML templates.

Concatenated plugin HTML templates.

get

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Responses

200

The HTML template bundle.

text/html

stringOptional

200

The HTML template bundle.

text

GET /plugin/bundle/l10n/{lang}.json — Concatenated plugin translations for a language.

Concatenated plugin translations for a language.

get

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Path parameters

langstringRequired

Language tag (e.g. de-DE, en-US).

Responses

200

Flat translation map merged across all enabled plugins.

application/json

Other propertiesstringOptional

200

Flat translation map merged across all enabled plugins.

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

GET /plugin/static/{plugin}/{path} — Download a bundled static asset of a plugin.

Download a bundled static asset of a plugin.

get

Serves a file from the named plugin's static asset directory by its path relative to the plugin's static root. The route is a prefix mount, so {path} may contain further / segments.

Public: no access token is required. The plugin must be enabled.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Path parameters

pluginstringRequired

Plugin name (the manifest name:).

pathstringRequired

Path of the asset relative to the plugin's static root.

Responses

200

The requested asset. The content type depends on the file.

application/octet-stream

string · binaryOptional

400

The plugin exists but is disabled (code: PluginDisabled).

application/json

404

No plugin with this name (code: PluginNotFound). A missing asset within an existing, enabled plugin is reported by the file server itself (a plain-text 404 for disk-backed plugins, or a code: ServerGeneric 400 when the ZIP read fails for zip/url-backed plugins) — not as PluginNotFound.

application/json

binary

GET /plugin/extension/{plugin}/{path} — Call a plugin-defined backend extension endpoint.

Call a plugin-defined backend extension endpoint.

get

Forwards to the plugin's extension callback. The response body and status are defined by the plugin; extensions may also set custom X-Fylr-Error / X-Fylr-Error-Code headers and return non-2xx status codes (e.g. 400, 402, 500) with their own body shape.

The same mount also handles POST, PUT, PATCH and DELETE requests.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

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

Path parameters

pluginstringRequired

Plugin name (the manifest name:).

pathstringRequired

Extension route path as declared in the plugin manifest. The mount is a prefix, so this may contain further / segments.

Responses

200

Plugin-defined success response. Shape depends entirely on the extension implementation.

No content

400

The named plugin exists but is disabled (code: PluginDisabled). Checked before the access-token requirement.

application/json

401

The request did not carry a valid access token (code: UserRequired).

application/json

404

No plugin with this name (code: PluginNotFound, JSON PluginError body). When the plugin exists and is enabled but has no extension matching {path}, the handler instead returns a plain-text 404 page not found with no JSON body.

application/json

No content