Gate vocabulary

The words of API access and the gate: access, token, app key, slug, generation, re-sealing, and the others.

On this page
Documentation sections

The words used by the API access screens and the documentation of the gate.

wordwhat it means
Accesswhat you create with Open to an API…: a name, databases opened (in read or in read and write), an expiry, allowed addresses, a token.
Gate (Filarr Gate)the program that holds the token, decrypts the opened databases and serves your software. It runs on your side: on a computer, a server, your Cloudflare account, or inside your code.
Tokenflr_live_…, shown only once when the access is created. It opens the access's databases and nothing else. Filarr only keeps a fingerprint of it.
App keygk_…, created on the gate for ONE program, limited to what it needs. Your software never holds the token.
Slugthe name of a database or a view in the API (clients, clients-actifs), chosen when the access is created and kept afterwards, even if you rename.
Addresswhere a program reads a database or a view: /v1/<database slug> or /v1/<database slug>/<view slug>.
Generationthe number of a database's key. Removing a database from an access, or revoking the access, moves it to the next generation: the old token reads nothing written afterwards.
Re-sealingwhen one of your devices hands an access the key of a new generation (after keys changed for another access, for example). Until then, the gate reports "missing key".
Missing key (key_missing)the gate lacks the key of some blocks of a database: a device of the access creator must open Filarr. It never skips a block silently.
Manifestthe views of a database as the gate receives them, sealed for it alone. It is published again when you change a view, the title or the columns.
Pollingwithout a live stream (Free plan), the gate asks for changes at a regular interval.
Commita write of the gate accepted by Filarr. One commit can carry several rows; it is what the writes limit counts.
Revokecut an access off for good: the token is refused at once, and the databases' keys change.

Learn more