Gate troubleshooting
What each API access message in Filarr means, and what to do: the form, Settings → API access, a silent gate or a missing key.
On this page
Documentation sections
The messages of the Open to an API… and Settings → API access screens, and the states the gate shows. For the codes the gate returns to your software, see the troubleshooting page of its repository: github.com/filarr-work/filarr-gate.
In the "Open to an API" form
| message | what to do |
|---|---|
| Not available yet | API access is not open for your account yet: nothing to do on your side |
| Only the owner of a database, or an admin of its vault, can open it to an API | ask the vault's owner |
| A database backed by a folder cannot be opened to an API | its rows are files: serve those files another way |
| A database kept in your own storage cannot be opened to an API | it stays in your storage: no API for it |
| Your plan has no room left for an open API access | pause or revoke an access in Settings → API access |
| Your plan opens fewer databases per access | tick fewer databases, or move to a higher plan (plans) |
| Writing through the API is not included in your plan | choose Read, or a plan from Solo |
| Allowed addresses are included from the Pro plan on | empty the field, or move to Pro |
| "…" is not an address or a range | write 203.0.113.7 or 10.0.4.0/24 |
| The key of one of these databases is not here: open its vault, then try again | the database's vault is closed on this device |
| Your account's keys are not loaded on this device | unlock Filarr, then try again |
| Large databases are not open yet for this account or vault | nothing to do for now |
| Too many accesses created this hour | try again later |
| The views of this database are too heavy to be published | lighten the views (fewer views, queries or columns) |
In Settings → API access
| what you see | what it means, and what to do |
|---|---|
| never seen | the gate never synced: check that it runs, that it has the whole right token, and that it reaches api.filarr.com |
| silent N h, silent N d | the gate has not shown up for that long: stopped, offline, or refused (address not allowed, token replaced). Look at the log What Filarr saw: a "token refused" says why |
| token refused (…) in the log | someone presents an invalid token for this access: an old token after a replacement, or a machine whose address is not allowed |
| 80 % of the limit of your plan is used | the gate goes on; at 100 %, it keeps its copy and waits for the next window for what goes through Filarr |
| The keys of these databases will change as soon as their vault is open and the server reachable | a change of keys is waiting: open the vault, online |
| The views of N databases will be published again the next time their note is opened | after a token replacement, open those notes once |
What the gate says
| state | what to do |
|---|---|
| missing key for (e, g) | Filarr changed a database's keys and has not re-sealed them for this access yet: open Filarr, unlocked, on a device of the access creator |
| revoked | the access was revoked or its token replaced: give it the new token |
| expired | create a new access, or push the expiry back before it is reached |
| paused | reopen the access in Settings → API access |
| IP address refused | add its machine's public address to the access's allowed addresses |
| limited | a limit of your plan is reached: it serves its last copy and resumes on its own |