← Home
⌕
Ask on Discord
General ER:LC FiveM API
Developers
DOCUMENTATION/Public API v1

Keys and scopes

Public API keys: who creates them, which scopes exist, what each one opens, how to rotate them and how many each plan gives.

As of today the app does not have the screen to create API keys or webhooks yet. This page describes how keys work.
NOTE As of today the app does not have the screen to create API keys or webhooks yet. This page describes how keys work.
A key belongs to one server. It is created by the server owner or a role with the manage_api_keys permission («Crear, rotar y revocar las llaves de la API pública y los webhooks del servidor»). That permission does not come with the admin role: it has to be granted separately, because a key can read the whole server.
NOTE A key belongs to one server. It is created by the server owner or a role with the manage_api_keys permission («Crear, rotar y revocar las llaves de la API pública y los webhooks del servidor»). That permission does not come with the admin role: it has to be granted separately, because a key can read the whole server.
NOTE
Format: bx_live_ followed by 48 letters and digits. It is shown only once; Blixye only stores its fingerprint (SHA-256).
Scopes: at least one, from the list below. There is no wildcard.
Allowed IPs: optional, up to 20 IPs or CIDR ranges (IPv4 or IPv6). Empty = from anywhere. From another IP, 403 ip_not_allowed.
Expiry: optional, 1 to 3650 days. Once expired, 401 api_key_expired.
The 16 scopes
NOTE The 16 scopes
NOTE
server:read opens GET /server.
characters:read opens GET /characters, /characters/{id} and /characters/{id}/licenses.
inventory:read opens GET /characters/{id}/inventory, together with characters:read.
vehicles:read opens GET /vehicles.
records:read opens GET /citations, /arrests and /records; records:write, POST /citations.
dispatch:read opens GET /calls and /calls/{id}; dispatch:write, POST /calls and PATCH /calls/{id}.
units:read opens GET /units.
corporations:read opens GET /corporations, /corporations/{id}/ranks and /corporations/{id}/members.
bank:read opens GET /bank/transactions.
members:read opens GET /members and /roles.
moderation:read opens GET /sanctions and /bans; moderation:write, POST /sanctions.
erlc:read opens GET /erlc/sessions.
webhooks:manage opens all of /webhooks. It only lets you subscribe a webhook to events covered by the same key's scopes (Webhooks).
Read scopes also grant their resource's events in GET /v1/events and in webhooks (dispatch:read, units:read, records:read, characters:read, vehicles:read, moderation:read, erlc:read and corporations:read; the list is in API v1: events). A route without its scope answers 403 missing_scope, with the missing ones in details.required_scopes.
NOTE Read scopes also grant their resource's events in GET /v1/events and in webhooks (dispatch:read, units:read, records:read, characters:read, vehicles:read, moderation:read, erlc:read and corporations:read; the list is in API v1: events). A route without its scope answers 403 missing_scope, with the missing ones in details.required_scopes.
Rotating and revoking
NOTE Rotating and revoking
NOTE
Rotating creates a new key with the same scopes, IPs and expiry. The old one stops working at once or, if you give a grace period of up to 1440 minutes (24 hours), when that period ends, so you can swap it in your integration without downtime. Rotating does not count against the plan cap.
Revoking is immediate: the next request with that key answers 401 api_key_revoked.
A key sent in the URL or in the body is rejected with 400 api_key_in_query and must be rotated: those keys end up in web server logs.
30 failed authentications in one minute from the same IP get a 429 for that IP, without checking the key.
How many each plan gives
NOTE How many each plan gives
api_keys is the server's active keys; api_rpm, the requests per minute for EACH key; webhook_endpoints, the server's webhook destinations. Going over the key or destination cap gives 409 limit_reached.
NOTE api_keys is the server's active keys; api_rpm, the requests per minute for EACH key; webhook_endpoints, the server's webhook destinations. Going over the key or destination cap gives 409 limit_reached.
NOTE
plan api_keys api_rpm webhook_endpoints
none 0 0 0
plus 1 60 1
premium 3 300 5
business 10 1200 20
← Previous
Public API v1: introduction
Next →
Errors
32 / 54 Something missing here →
STEP 1 · PLAN ×
Pick your server's plan
After payment you name it and we configure it together. You can change plan whenever you like.
FREE1 OF 1 LEFT Up to 500 characters and basic CAD. To try it. 0 €
PLUSMONTHLY Full CAD, moderation, activity and economy. 5,99 €
PREMIUMER:LC & FIVEM Everything in PLUS, with the live map and higher limits. 12,99 €
ENTERPRISEPERMANENT All of PREMIUM forever, self-hosted, never a fee. Contact
Continue to payment
Cancel any time · 14-day withdrawal right, unless you ask to start straight away
Confirm and pay
ER:LC PREMIUM
Monthly · one licence
12,99 €
EMAIL
CARD
Back
In development — unavailable
Blixye is in development: services can’t be purchased yet.Secure payment · VAT included
Name your server
This is the name your players see in the launcher and on Discovery. You can change it whenever.
SERVER NAME
It gets a short code, like SKY-T2Q, to link the launcher.
NEXT Once created we open the setup guide: launcher, Discord and modules in three steps.
Back
Create the server
Type at least 3 characters.
STEP 1 OF 3 · GUIDE ×
1. Send your people the launcher
It is the only thing they install, and only once. They sign in with Discord, we verify their Roblox account and the overlay shows over the session.
Go to the download
2. Create your departments
Police, sheriff, fire or whatever you run. Each with its ranks and permissions: that decides who can punish, clock in or read records.
3. Open the server
With the first duty shift the calls, activity and economy start filling up. From there you just tune it.
Back
Next
⌕ ESC
In-game overlay Radio, sheet and dispatch over the session, no alt-tab. ER:LC CAD and departments Queued calls, units with status and rosters with ranks. ER:LC Moderation and appeals Punishments with context, logs and appeals that do not get lost. ER:LC Staff activity Quotas per rank, shifts and an automatic weekly report. ER:LC Economy and businesses Accounts, payroll, player businesses and inventory. ER:LC Blixye Framework The core: characters, permissions, database and QBCore and ESX bridge. FiveM Inventory Weight, containers and safe player trades. FiveM Police MDT Records, fines, warrants and plate lookups. FiveM Banking Accounts, transfers, payroll and business accounts. FiveM Jobs Shifts, payroll and per-company hierarchy. FiveM Garages Vehicle ownership, persistent damage and impound. FiveM Housing Buying, renting, furniture and personal storage. FiveM Phone Messages, calls, apps and in-world socials. FiveM EMS Per-limb injuries, treatment and a hospital with beds. FiveM All the scripts All eight scripts unlimited, as a permanent purchase or a subscription. FiveM Install Blixye on ER:LC From an empty server to the first duty shift, without touching a game file. Docs Install the FiveM framework The zip, the SQL and your current base bridge, in the right order. Docs Your first week What to set up each day so you do not end up with twenty half-done things. Docs CAD and dispatch Calls, units and priorities inside the overlay. Docs Moderation and appeals Punishments with evidence, appeals and the log that covers you. Docs Activity and shifts Hours, quotas and who is really patrolling. Docs Scripts and free version What each script free version limits and what the full one opens. Docs QBCore and ESX bridge Living with your current base without duplicating players or money. Docs Performance Where to look when the server stutters. Docs
Nothing by that name. Try “inventory”, “CAD” or “licences”.
↵ open CTRL K search 37 results
ROTATE THE KEY ×
! The current key stops working the moment you confirm. This cannot be undone.
current key → new key on confirm
Paste the new key into the script config.
Restart the resource: refresh and ensure.
Until you do, the script will not load.
Yes, rotate the key Cancel
What each plan includes ×
FREE
DISCORD
PLUS
PREMIUM
ENTERPRISE
Price
Free
2,99 €/mo
5,99 €/mo
12,99 €/mo
Contact
GENERAL
Server members
50
—
150
∞
∞
Custom invite code
—
✓
✓
✓
✓
CAD
Max corporations
2
—
6
∞
∞
Max subdivisions
0
—
6
∞
∞
MDT data wipe
1 month
—
1 year
Never
Never
MDT access
Complete
—
Complete
Complete
Complete
Logs history
7 days
—
90 days
∞
∞
PDF export
—
—
—
✓
✓
Investigations
—
—
✓
✓
✓
Evidence storage
—
—
Unmetered
Unmetered
Unmetered
Custom laws
50
—
150
∞
∞
MDT forms
3
—
15
∞
∞
Real-time map and location
—
—
—
✓
✓
Bodycam
—
—
✓
✓
✓
Advanced search
—
—
✓
✓
✓
Radio channels (Discord VC)
10
—
50
100
∞
Roles per corporation
15
—
50
∞
∞
BANK
Bank accounts
1 per char
—
3 per char
6 per char
12 per char
Transfers
✓
—
✓
✓
✓
Transaction history
✓
—
✓
✓
✓
Cards per account
1
—
2
3
5
Timed cards
Fixed durations
—
✓
✓
✓
Usage-based cards
—
—
Max 5 per char
✓
✓
Role rewards
✓
—
✓
✓
✓
Allow negative balance
—
—
✓
✓
✓
Scheduled transfers
—
—
✓
✓
✓
Player debts
—
—
✓
✓
✓
Per-operation limits
—
—
✓
✓
✓
Shared accounts
Max 2 members
—
Max 5 members
∞
∞
ADMIN
Player heatmap
—
—
—
✓
✓
Bot forms
3
5
10
∞
∞
Your server on the phone
—
—
✓
✓
✓
Max admin roles
owner +2
owner +5
owner +10
∞
∞
Priority support
—
✓
✓
✓
✓
Staff audit log history
7 days
30 days
90 days
∞
∞
Beta features
—
✓
✓
✓
✓
Create server
Character and storage addons stack on any plan.
Cookies ESSENTIAL ONLY
We only use the essential ones: your session, sign-in security and your language. There is no analytics and no advertising, so there is nothing to accept or reject.
Got it
Cookie policy